0.3.7 β’ Published 6 years ago
simpler-paper v0.3.7
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
{
// 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
}
LICENSE
0.3.7
6 years ago
0.3.6
6 years ago
0.3.5
6 years ago
0.3.4
6 years ago
0.3.3
6 years ago
0.3.2
6 years ago
0.3.0-beta.4
6 years ago
0.3.0-beta.3
6 years ago
0.3.0-beta.2
6 years ago
0.3.0-beta.1
6 years ago
0.2.2
6 years ago
0.2.1
6 years ago
0.2.0
6 years ago
0.1.11
6 years ago
0.1.10
6 years ago
0.1.9
6 years ago
0.1.8
6 years ago
0.1.7
6 years ago
0.1.6
6 years ago
0.1.5
6 years ago
0.1.4
6 years ago
0.1.3
6 years ago
0.1.2
6 years ago
0.1.1-rc.3
6 years ago
0.1.1-rc.2
6 years ago
0.1.1-rc.1
6 years ago
0.1.1-beta.3
6 years ago
0.1.1-beta.2
6 years ago
0.1.1-beta.1
6 years ago
0.1.1-alpha.3
6 years ago
0.1.1-alpha.1
6 years ago
0.1.0-alpha.6
6 years ago
0.1.0-alpha.5
6 years ago
0.1.0-alpha.4
6 years ago
0.1.0-alpha.3
6 years ago
0.1.0-alpha.2
6 years ago
0.1.0-alpha.1
6 years ago