simpler-paper

> A very simple document generator. preview.
> Quickly build and deploy markdown files with a few commands.

Guide

- Feature
- Getting Started
- Configuration Details
- Documentation
- LICENSE
- 中文

$3

- Agility. just one script(only ~3kb gzipped), no framework.
- Easy. just one command.
- Lazy load.
- Auto compatible mobile phone.
- More themes.

$3

1. Install: npm i -g simpler-paper
2. Init: paper init . To create the document folder or generate the config file in existing folder.
3. Add markdown files in document folder.
- Create a folder named "assets" to store the images if needed.🤔🤔
- Add a munber prefix connected by '_' to sort the document or folder. (e.g. 1_firstDoc.md)
- Hierarchical directory generated by the documents folder.
4. Build: paper build . If you want to preview, run paper server .
5. Deploy: paper deploy . Deploy a Git repository to GitHub.
Remember to set to GitHub pages.

$3

You can create a paper.config.json file in the document directory.

> Run paper init can quickly create paper.config.json

``typescript
// 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
}
``

$3

MIT