othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
cd1cbf0f85
ohif-viewer/docs
History
dannyrb cd1cbf0f85 docs: fix GitHub table formatting issue
2019-12-09 09:56:17 -05:00
..
latest docs: fix GitHub table formatting issue 2019-12-09 09:56:17 -05:00
v1 fix: measurementsAPI issue caused by production build (#842) 2019-09-04 13:53:13 -04:00
_redirects ci: fix docs deploy-preview redirect (#878) 2019-09-06 15:09:20 -04:00
.gitignore Don't track gitbook output 2019-04-17 16:41:59 -04:00
CNAME move CNAME file 2019-04-17 14:03:32 -04:00
README.md Quick readme on how to write/dev docs 2019-04-19 10:45:09 -04:00
win-server-workaround.bat Silly little bat script to make dev on windows less painful 2019-04-17 16:42:56 -04:00

README.md

How To: Documentation Step-by-Step

We use GitBook to create our documentation. It primarily uses markdown, html, css, js, misc. plugins, and configuration to generate high quality, easy to read, and easy to maintain documentation.

Getting Started

Requirements:

Make sure you have the gitbook-cli installed globally:

npm install -g gitbook-cli

Editing and Previewing Changes

Currently, you can only edit and preview a single "book" at a time. We maintain one "book" per API major version. You can find each version's book at:

Past Versions:

  • Template:
    • <project-root>/docs/v<versionNumber>
  • Examples:
    • /docs/v1
    • /docs/v2

Latest Version:

The latest version will always be located in /docs/latest

Live Preview:

In your terminal / command prompt:

cd /docs/latest
gitbook install
gitbook serve

Which should generate output like:

starting server... serving book on http://localhost:4000

Navigating to the the provided URL will show a preview of what the generated book should look like. Any edits you make to the book's markdown files should automatically update in your browser.

Publishing