elegant document generation tool.
elegant document generation tool. preview.
quickly build and deploy markdown files with a few commands.
npm i -g simpler-paper
paper init
. To create the document folder or generate the config file in existing folder.paper build
. If you want to preview, run paper server
.paper deploy
. Deploy a Git repository to GitHub.
Remember to set to GitHub pages.You can create a paper.config.json
file in the document directory.
Run
paper init
can quickly createpaper.config.json
// paper.config.json
{
// document the alias, the value will be displayed after compilation, default: null
"alias": {
"quickstart": "Getting Started",
...
},
// document title, default: "simpler paper"
"title": "",
// back to top button, default: true
"backToTop": true,
// document page path, default: "/"
"docPath": "/",
// loading indicator, default: true
"indicator": true
}