ดาวน์โหลด 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

ต้องใช้ไฟล์ Markdown ทั้งหมดในโฟลเดอร์ปัจจุบัน (และโฟลเดอร์ย่อย) และสร้างไซต์ใหม่ในไดเรกทอรี build

แปลงไฟล์ README.md เป็นดัชนี ( index.html )
สร้างดัชนีไดเรกทอรีสำหรับ URL สวย ๆ ( CHANGELOG.md => changelog/index.html )
รองรับเลย์เอาต์ที่กำหนดเอง (มาพร้อมกับ layout.html เริ่มต้น)
สำเนาสินทรัพย์ (ค่าเริ่มต้นไปยังการคัดลอกเนื้อหาของโฟลเดอร์ assets )
มาพร้อมกับโหมด dev ที่เริ่มต้นเซิร์ฟเวอร์และเฝ้าดูการเปลี่ยนแปลงเพื่อการพัฒนาในท้องถิ่นที่ง่าย

เว็บไซต์ของ Sitedown ถูกสร้างขึ้นด้วย 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> ใน <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 >

เค้าโครงเริ่มต้นมาพร้อมกับ style.css ซึ่งเป็นสไตล์ชีทที่ไม่มีคลาสสำหรับเอกสาร Markdown

ดัชนีไดเรกทอรี (URL สวย)

ไฟล์ Markdown ( $f.md , $f.markdown ) มีการลดลงและแยกวิเคราะห์เป็นไฟล์ $f/index.html ดัชนีไดเรกทอรีสามารถปิดใช้งานได้ด้วยตัวเลือก pretty: false ไฟล์ README.md จะถูกแปลงเป็นดัชนีไดเรกทอรีเสมอ ( index.html )