Skip to content

Getting Started

Kevin Cyu edited this page Nov 18, 2017 · 11 revisions

Support function of docoGen

Click the link to see latest support!

Step by step

  1. Install node.js

  1. Using npm to get the package

  1. After installation, if you first time to use docoGen, you can use the script to install our dependencies.
    • Under the directory which just npm install to get docoGen in previous step, run:
    • For Linux users: bash node_modules/docogen/install_dep.sh
    • For Window users: .\node_modules\docogen\install_dep.bat

It will take several minutes to download dependencies (Both Linux, Window platform) When download process has been done, the installation window will pop up (For Window user)

  1. After you get all dependencies, now it's time to play!

    • Write down the script in .docogen with JSON format

    New feature! Also, you can edit markdown script instead using .docogen. Cheer!

    • Overview
  2. When all docogen script has been added, we can generate LaTeX pdf now!

    • Write the js file named latex_method.js (you can see more in test/)
    • And run the command node <your.js>
    • If you see this, it means generating process has been done!
  3. Check the result!

Clone this wiki locally