Skip to content

Contributing to docs

Adrian Abreu Gonzalez edited this page Mar 22, 2018 · 1 revision

SIMDE's docs are written on Markdown and published on gitbook.

If you would to contribute to the docs, you should check about markdown.

And also you should use and editor that can preview Markdown like VSCode

When you're editing a .md file just type:

Ctrl + Shift + P > Open Preview to the side.

For seeing in development the whole docs results, just use gitbook.

Install gitbook as a npm tool npm i -g gitbook-cli and type gitbook install in the project's folder.

Once it finishes, type gitbook serve and check the project at http://localhost:4000

Note: There is a bug in windows and the project may crash when saving a new file, the best solution I've found by now is to use a small .bat

:Start
call gitbook serve
goto Start
Clone this wiki locally