Skip to content

Latest commit

 

History

History
54 lines (25 loc) · 1 KB

CONTRIBUTE.rst

File metadata and controls

54 lines (25 loc) · 1 KB

How to contribute

Clone the repository and create pull request.

General

To be written.

Automatic local rendering and browser reload

Here is a recipe setting this up using npm and Node.

It will render the manual locally, start a local server and open the manual in your browser. Whenever you make a change, the rendering is done again and the browser will automatically reload. A local rendering will take place whenever you make changes. The result will be served to your to setup up automatic local rendering and browser reloads.

Prepare:

  1. Install Node. This will also install npm

  2. Install some modules globally:

    npm install -g yarn gulp-cli
    
  3. Set up the ./node_modules using yarn and package.json:

    yarn install
    

Use:

# Find out what's available
yarn run
yarn gulp --tasks-simple