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

Guide

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

Feature

• Agility. just one script(only ~3kb gzipped), no framework.

• Easy. just one command.

• Lazy load.

• Auto compatible mobile phone.

• More themes. simpler-paper-themes

Getting Started

1. install: npm i -g simpler-paper

2. init: paper init . to create the doc folder or generate the config file in existing folder.

3. add markdown files in document folder. 🤔🤔

4. build: paper build . if you want preview: paper server .

5. deploy: paper deploy . make sure the current directory of operations is a Git repository. Set to GitHub pages on GitHub after deployment.

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