sitedown 다운로드 - sitedown 소스 코드 다운로드

sitedown

웹사이트 데이터

v5.1.3

다운로드

개요

Sititedown은 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

현재 폴더 (및 서브 폴더)의 모든 Markdown 파일을 사용하고 build 디렉토리에서 새 사이트를 생성합니다.

README.md 파일을 index ( index.html )로 변환합니다.
Pretty URL에 대한 디렉토리 인덱스를 만듭니다 ( CHANGELOG.md => changelog/index.html ).
사용자 정의 레이아웃을 지원합니다 (기본 layout.html 포함되어 있음).
자산을 복사합니다 ( assets 폴더의 컨텐츠에 대한 복사의 기본값).
서버를 시작하고 현지 개발이 쉬운 변경 사항을 시청하는 dev 모드가 제공됩니다.

Sititedown의 웹 사이트는 Sittitown과 함께 제작되었으므로 실제라는 것을 알고 있습니다.

옵션 및 기본값에 대한 전체 개요는 사용 섹션을 읽으십시오.

설치하다

 npm install sitedown

용법

클리

 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 )은 저하되어 $f/index.html 파일로 구문 분석됩니다. pretty: false 옵션으로 디렉토리 인덱스를 비활성화 할 수 있습니다. README.md 파일은 항상 디렉토리 인덱스 ( index.html )로 변환됩니다.