sitedown Download - sitedown Source Code Download

sitedown

Website-Daten

v5.1.3

Herunterladen

Überblick

Sitedown verwandelt einen Ordner mit Markdown -Dateien in eine statische HTML -Site.

 .                              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

Es wird alle Markdown -Dateien im aktuellen Ordner (und Unterordner) angezeigt und generiert eine neue Site im build -Verzeichnis.

Konvertiert README.md -Dateien in Indizes ( index.html ).
Erstellt Verzeichnisindizes für hübsche URLs ( CHANGELOG.md => changelog/index.html ).
Unterstützt benutzerdefinierte Layouts (enthält ein layout.html ).
Kopiert Vermögenswerte (Standardeinstellungen zum Kopieren des Inhalts des assets ).
Kommt mit einem dev , der einen Server startet und nach Änderungen für die einfache lokale Entwicklung beobachtet.

Die Website von Sitedown wurde mit Sitedown erstellt, sodass Sie wissen, dass es echt ist.

Lesen Sie den Nutzungsabschnitt für einen vollständigen Überblick über Optionen und Standardeinstellungen.

Installieren

 npm install sitedown

Verwendung

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

Knoten -API

 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

Alle Dateien sind in eine layout.html -Datei eingewickelt. Der Markdown-Inhalt wird an das erste .markdown-body Element angehängt, und der Seitentitel ( <title> in <head> ) wird auf den Text des ersten h1 Elements eingestellt.

Das Standardlayout ist:

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

Das Standardlayout wird mit style.css , einem klassenlosen Stylesheet für Markdown -Dokumente, gebündelt.

Verzeichnisindizes (hübsche URLs)

Markdown -Dateien ( $f.md , $f.markdown ) werden niedriger und in $f/index.html -Dateien analysiert. Verzeichnisindizes können mit der Option pretty: false deaktiviert werden. README.md -Dateien werden immer in Verzeichnisindizes ( index.html ) konvertiert.