docspress v1.0.4

Docspress

Based on the command line tool packaged by docsify, one-click conversion of Markdown to documentation website

Install

npm install docspress -g

Use

# Specify docs as the documentation directory by default
docspress
# specify the directory
docspress -i <path>

After running, some files will be generated in the document directory, such as index.html _navbar.md _sidebar.md

Sort

How to sort documents, use numbers + dashes to sort articles

file name

01-Chapter 1.md
02-Chapter 1.md
03-Chapter 3.md
README.md

build directory

README
Chapter One
Chapter two
third chapter

I18n

{
   "siteTitle":"Docspress",
   "langs": {
     "cn": {
       "dir": "zh-cn",
       "text": ":cn: Chinese"
     }
   }
}

Rest HTTP request

GET /api/config/general/get.json HTTP/1.1
content-type: application/json