elegant document generation tool.
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
build
examples
src
templates/app
typings
.gitignore
.travis.yml
LICENSE
README.md
README_CN.md
commitlint.config.js
logo.png
package-lock.json
package.json
tsconfig.json
tslint.json

README.md

elegant document generation tool. 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

  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.

Configuration Details

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

Run paper init can quickly create paper.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

MIT