16cea8681e
* update i18n version -- already published * update ohif/i18n version and add modules * update ohif/i18n version * update translating documentation * replace addLocales method and exported modules * lock files * Update index.js * fix(@ohif/i18n): export custom methods in the main i18n object `initI18n`, `addLocales` and `T` are now being exported inside the main `i18n` object. * remove unecessary dependencies * update vtk-extension lock file |
||
|---|---|---|
| .. | ||
| latest | ||
| v1 | ||
| .gitignore | ||
| CNAME | ||
| README.md | ||
| win-server-workaround.bat | ||
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.