A very simple document generator. preview.
Quickly build and deploy markdown files with a few commands.
Guide
Feature
- Agility. just one script(only ~3kb gzipped), no framework.
- Easy. just one command.
- Lazy load.
- Auto compatible mobile phone.
- More themes.
Getting Started
- Install:
npm i -g simpler-paper
- Init:
paper init
. To create the document folder or generate the config file in existing folder. - 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.
- Build:
paper build
. If you want to preview, runpaper server
. - Deploy:
paper deploy
. Deploy a Git repository to GitHub. Remember to set to GitHub pages.
Configuration Details
You can create a paper.config.json
file in the document directory.
Run
paper init
can quickly createpaper.config.json
// paper.config.json