papoGen

Using paper.css and pug.js to generate.

If you feel papogen is good, hope you can give a star!

usage

使用說明 - 中文詳細版本

• Install

» [sudo] npm install papogen -g

• Help Manual (List out current support)

  • Explain each parameter we support currently!
  • See more in here.

• Generate

» papogen -s test/ -o docs/ -t papoGen -m doc

• Our document demo page, is generate by papoGen!

  • Using the json files in test/
    • In test/, there are several categories of scripts, each one has a directory
    • And there have a README.md inside each directory, explain the format of each type.
  • View more:
    • doc page
    • resume page

• Generate script template

  • After you using -h to list, you can see the last part of all script support.
  • And you can using papogen -c <script>/<format_1>/<format_2>/... -o <output> to generate our template file.
    • <script> is the blue one. (in -h output message)
    • <format> is the grey one. (in -h output message)
      • version after 0.0.12 support several template specified, use / to separate each format.
      • or you can just using json/all to get all current support copy to target output directory

• Check our example/ to see more!

Markdown (Recommended!)

• Generate from markdown directly.
• Different from above format.
• Still support multiple markdown files as input.
• support model:
  • md_doc
• Example command:

papogen -s test/md -o docs/md -g md -m md_doc -t Graph\ Theory   

json(default)

• Example command:
• See more in here

# Use directly (from source code)
» node main.js -s test/ -o docs/ -t papoGen
# By install 
» papogen -s test/ -o docs/ -t papoGen -m doc

• Using json as configuration.
• After specify the src directory, paperUI will fetch all .json under src, and using each filename to be as "tag" in output.
• And then will base on specified format to generate content (see more detail below)
  • Currently support: text (see the source dir: test/ as input, and destination dir: docs/ as output)

yaml

• With some format defined in json.
• Example command:

# Use directly (from source code)
» node main.js -s test/ -o docs/ -g yaml -t papoGen
# By install 
» papogen -s test/ -o docs/ -t papoGen -m doc -g yaml

• Using yaml as configuration.
• After specify the src directory, paperUI will fetch all .json under src, and using each filename to be as "tag" in output.
• And then will base on specified format to generate content (see more detail below)
  • Currently support: text (see the source dir: test/ as input, and destination dir: docs/ as output)

Demo

• Generate by papoGen format
  • JSON - doc
  • JSON - resume
  • YAML - doc
  • YAML - resume
• Generate directly from Markdown format
  • From Markdown - md_doc
    • Support "MathJax" & "Table of content"!
  • Graph Theory Tutorial:
    • ch3
    • ch4
  • simulation project - 802.11 wireless illustration
  • gRPC practice & learn

Changelog

• See here.

• Screenshot

version	Table of content	Main Page
v0.2.2

Workflow

• See here

Author

Kevin Cyu, kevinbird61@gmail.com