sitedownダウンロードsitedownソースコードのダウンロード

sitedown

ウェブサイトデータ

v5.1.3

ダウンロード

概要

Sitedownは、Markdownファイルを備えたフォルダーを静的HTMLサイトに変換します。

 .                              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

現在のフォルダー（およびサブフォルダー）のすべてのマークダウンファイルを取得し、 buildディレクトリに新しいサイトを生成します。

README.mdファイルをインデックス（ index.html ）に変換します。
Pretty URL（ CHANGELOG.md => changelog/index.html ）のディレクトリインデックスを作成します。
カスタムレイアウトをサポートします（デフォルトのlayout.html ）。
アセットのコピー（デフォルトは、 assets Folderのコンテンツを介してコピーすることになります）。
サーバーを起動するdevモードが付属し、ローカル開発のための変更を監視します。

SitedownのWebサイトはSitedownで構築されたので、それが実際にあることを知っています。

オプションとデフォルトの完全な概要については、使用法セクションをお読みください。

インストール

 npm install sitedown

使用法

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

 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.htmlファイルにラップされています。 Markdownコンテンツは最初の.markdown-body要素に追加され、ページタイトル（ <title> in <head> ）は最初のh1要素のテキストに設定されます。

デフォルトのレイアウトは次のとおりです。

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

デフォルトのレイアウトには、Markdownドキュメント用のクラスレススタイルシートであるstyle.cssがバンドルされています。

ディレクトリインデックス（プリティURL）

Markdownファイル（ $f.md 、 $f.markdown ）は低casedで、 $f/index.htmlファイルに解析されます。ディレクトリインデックスはpretty: falseオプションで無効にすることができます。 README.mdファイルは常にディレクトリインデックス（ index.html ）に変換されます。