Skip to content

gmdr1024/honkit-dev

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

33 Commits
 
 
 
 
 
 
 
 

Repository files navigation

honkit-dev

Honkit dev

Description

Documentation dev based Markdown & mermaid

Feature

Requirement

Node.js 14.16.x

Pre-Install

  • Node.js
  • EditorConfig
  • Enable ebook-convert for generate PDF file
    1. Download & install Calibre
    2. Add the installation folder path to your environment variables

Install

  1. Download code
  2. npm i under docs

Usage

  • Execute command under docs

Create page

  1. Add link to ~~.md to docs/SUMMARY.md (Table of contents)
  2. Add ~~.md file to doc/pages

Start a local server and render

  • npm start

Generate static files

  • npm build (To _book)

Generate PDF file

  • npm pdf

Re-use

  • Copy code in docs

Author

gmdr1024

License

CC0