Download de sitedown - Download de código fonte de sitedown

sitedown

Dados do site

v5.1.3

Baixar

Visão geral

Sitedown transforma uma pasta com arquivos de marcação em um site HTML estático.

 .                              build/
├─ README.md         ==>       ├─ index.html
├─ about.md          ==>       └─ about/
│                              │  └─ index.html
│                              │
├─ docs/                       └─ docs/
│  ├─ README.md      ==>       │  ├─ index.html
│  └─ ref.md         ==>       │  └─ ref/
│                              │     └─ index.html
│                              │
└─ assets/                     └─ assets/
   └─ cat.jpg        ==>          └─ cat.jpg

Ele leva todos os arquivos de marcação na pasta atual (e subpastas) e gera um novo site no diretório build .

Converte os arquivos README.md em índices ( index.html ).
Cria índices de diretório para URLs bonitos ( CHANGELOG.md => changelog/index.html ).
Suporta layouts personalizados (vem com um layout.html padrão.html).
Copia os ativos (os padrões de copiar sobre o conteúdo da pasta de assets ).
Vem com um modo dev que inicia um servidor e observa as alterações para facilitar o desenvolvimento local.

O site da SITEDOWN foi construído com Sitedown, então você sabe que é de verdade .

Leia a seção de uso para obter uma visão geral completa das opções e padrões.

Instalar

 npm install sitedown

Uso

CLI

 Usage: sitedown [source] [options]

    Example: sitedown . -b dist -l layout.html

    source                path to source directory (default: current working directory)
    --build, -b           path to build directory (default: "build")
    --pretty              use directory indexes for pretty URLs (default: true)
    --el, -e              css selector for target element (default: ".markdown-body")
    --layout, -l          path to layout file
    --github-headings, -g add anchors to headings just like GitHub (default: false)
    --no-hljs-class       don't add the hljs class to codeblocks (default: false)
    --silent, -s          make less noise during build
    --watch, -w           watch a directory or file (experimental)
    --dev, -d             start development server (experimental) (default: false)
    --assets, -a          assets folder to copy (default: "assets")
    --version, -v         show version information
    --help, -h            show help

API do nó

 var sitedown = require ( 'sitedown' )

var options = {
  source : '.' ,            // path to source directory                 default: cwd
  build : 'build' ,         // path to build directory                  default: 'build' in cwd
  pretty : true ,           // use directory indexes for pretty URLs    default: true
  el : '.markdown-body' ,   // css selector for target element          default: '.markdown-body'
  layout : 'layout.html' ,  // path to layout                           default: none
  githubHeadings : false ,  // add anchors to headings just like GitHub default: false
  noHljsClass : false ,     // don't add hljs class to codeblocks       default: false
  silent : false           // make less noise during build             default: false
}

sitedown ( options , function ( err ) {
  if ( err ) return console . error ( err )
  console . log ( 'success' )
} )

Layout

Todos os arquivos são embrulhados em um arquivo layout.html . h1 <head> .markdown-body marcação é anexado ao primeiro <title>

O layout padrão é:

 <!DOCTYPE html >
< html lang =" en " >
  < head >
    < meta charset =" utf-8 " >
    < meta name =" viewport " content =" width=device-width, initial-scale=1 " >
    < title > </ title >
    < link rel =" stylesheet " href =" https://unpkg.com/style.css " >
  </ head >
  < body >
    < main class =" markdown-body " > </ main >
  </ body >
</ html >

O layout padrão vem com style.css , uma folha de estilo sem classe para documentos de remarca.

Índices de diretório (URLs bonitos)

Os arquivos de marcação ( $f.md , $f.markdown ) são mais baixos e analisados em arquivos $f/index.html . Os índices de diretório podem ser desativados com a opção pretty: false . Os arquivos README.md são sempre convertidos em índices de diretório ( index.html ).

Links

Os links relativos que apontam para os arquivos de marcação ( $f.md , $f.markdown ) são reescritos como $f/ para apontar para o seu equivalente $f/index.html .