ADLINK IPi documentation

Getting started

1. Install dependencies:

$ git clone https://github.com/ADLINK-EPM/ipi-doc-source.git
$ cd ipi-doc-source
$ npm install
$ npm install hexo-cli -g

2. Generate HTML website:

$ hexo clean
$ hexo g

3. Run server on local side:

$ hexo s

How to add/modify the source of ipi-doc

Basic rules

• your markdown and hexo source must build
• your image format goes to .png
• please use "Camel case" for your folder or file name.
  for example, HowToUseInstallUbuntu.md
• please make sure that website can work at your local side

How to work

• the recommneded method is to fork on github, and then send pull requests to the main proejct.
• we will get the notification to merge your changes and go public your html files