sitedown Download - sitedown Source Code Download

sitedown

Data situs web

v5.1.3

Unduh

Ringkasan

Sitedown mengubah folder dengan file -file markdown menjadi situs HTML statis.

 .                              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

Dibutuhkan semua file Markdown di folder saat ini (dan subfolder) dan menghasilkan situs baru di direktori build .

Mengubah file README.md menjadi indeks ( index.html ).
Membuat indeks direktori untuk URL cantik ( CHANGELOG.md => changelog/index.html ).
Mendukung tata letak khusus (dilengkapi dengan layout.html default.html).
Menyalin aset (default untuk menyalin melalui konten folder assets ).
Dilengkapi dengan mode dev yang memulai server dan mengawasi perubahan untuk pengembangan lokal yang mudah.

Situs web Sitedown dibangun dengan Sitedown, jadi Anda tahu itu nyata .

Baca bagian penggunaan untuk gambaran lengkap opsi dan default.

Memasang

 npm install sitedown

Penggunaan

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

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

Tata letak

Semua file dibungkus dalam file layout.html . Konten Markdown ditambahkan ke elemen .markdown-body pertama, dan judul halaman ( <title> di <head> ) diatur ke teks elemen h1 pertama.

Tata letak default adalah:

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

Tata letak default ini dibundel dengan style.css , stylesheet tanpa kelas untuk dokumen penurunan harga.

Indeks Direktori (URL cantik)

File Markdown ( $f.md , $f.markdown ) lebih rendah dan diuraikan menjadi file $f/index.html . Indeks Direktori dapat dinonaktifkan dengan opsi pretty: false . File README.md selalu dikonversi ke indeks direktori ( index.html ).

Tautan

Tautan relatif yang menunjuk ke file markdown ( $f.md , $f.markdown ) ditulis ulang sebagai $f/ untuk menunjuk ke setara $f/index.html mereka.