Descarga sitedown - Descarga del código fuente sitedown

sitedown

Datos del sitio web

v5.1.3

Descargar

Descripción general

Sitedown convierte una carpeta con archivos Markdown en un sitio 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

Toma todos los archivos de Markdown en la carpeta actual (y subcarpetas) y genera un nuevo sitio en el directorio build .

Convierte los archivos README.md en índices ( index.html ).
Crea índices de directorio para URL bonitas ( CHANGELOG.md => changelog/index.html ).
Admite diseños personalizados (viene con un layout.html predeterminado.html).
Copia los activos (el valor predeterminado se copia sobre el contenido de la carpeta de assets ).
Viene con un modo dev que inicia un servidor y observa cambios para un desarrollo local fácil.

El sitio web de Sitedown fue construido con Sitedown, por lo que sabes que es de verdad .

Lea la sección de uso para obtener una descripción completa de las opciones y los valores predeterminados.

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 de nodo

 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' )
} )

Disposición

Todos los archivos están envueltos en un archivo layout.html . El contenido de Markdown se adjunta al primer elemento .markdown-body , y el título de la página ( <title> en <head> ) se establece en el texto del primer elemento h1 .

El diseño predeterminado es:

 <!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 >

El diseño predeterminado viene incluido con style.css , una hoja de estilo sin clase para documentos de Markdown.

Índices de directorio (URL bonitas)

Los archivos de Markdown ( $f.md , $f.markdown ) se reducen y se analizan en archivos $f/index.html . Los índices de directorio se pueden deshabilitar con la opción pretty: false . Los archivos README.md siempre se convierten en índices de directorio ( index.html ).

Campo de golf

Los enlaces relativos que apuntan a los archivos de Markdown ( $f.md , $f.markdown ) se reescriben como $f/ para apuntar a su equivalente $f/index.html .