https://github.com/unix/simpler-paper

elegant document generation tool.
https://github.com/unix/simpler-paper

doc-gen documentation documentation-tool markdown-blog markdown-viewer

Last synced: 2 months ago
JSON representation

elegant document generation tool.

• Host: GitHub
• URL: https://github.com/unix/simpler-paper
• Owner: unix
• License: mit
• Created: 2017-11-05T09:13:27.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-02-12T03:52:35.000Z (over 7 years ago)
• Last Synced: 2025-03-10T18:11:22.610Z (2 months ago)
• Topics: doc-gen, documentation, documentation-tool, markdown-blog, markdown-viewer
• Language: TypeScript
• Homepage:
• Size: 771 KB
• Stars: 148
• Watchers: 13
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        





















> elegant document generation tool. [preview](http://paper.wittsay.cc/).

> quickly build and deploy markdown files with a few commands.    

## Guide  

- [Feature](#feature)  

- [Getting Started](#getting-started)  

- [Configuration Details](#configuration-details)  

- [Documentation](http://paper.wittsay.cc/)

- [LICENSE](#license)  

- [中文](README_CN.md)

### Feature  

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

- Easy. just one command.  

- Lazy load.  

- Auto compatible mobile phone.  

- [More themes](https://github.com/DhyanaChina/simpler-paper-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](https://help.github.com/articles/configuring-a-publishing-source-for-github-pages/#enabling-github-pages-to-publish-your-site-from-master-or-gh-pages) 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`

```typescript

// 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**](LICENSE)