Repository files navigation

elegant document generation tool.preview.

quickly build and deploy markdown files with a few commands.

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

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

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, runpaper server .
5. Deploy:paper deploy . Deploy a Git repository to GitHub.Remember toset to GitHub pages.

You can create apaper.config.json file in the document directory.

Runpaper 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}

MIT