othmane/ohif-viewer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
ce1a62a961
ohif-viewer/docs
History
Danny Brown 5ac9048ef0
feat: extension panels 
* Snapshot -- Switching branches
* fix classes and hooks for panel componet
* Restore button functionality
* feat: support for expandableToolMenu
* Shift cornerstoneTools config up a layer, and use globalToolSync
* Remaining initCornerstoneTools changes
* Pull in Segmentation Plugin
* Shift MeasurementsPanel to an extension
* Note regarding where data is coming from
* Make sure measurement callback is available
* Bump core version
* Shift MeasurementsTable to a local extensions directory
* Register appCommands as an extension
* Update package dependencies and yarn lock
* Support for panel width
* Ability to pass props to our panel component
* Add a safety check around calling our tacked on method for tool options
* Left sidebar plugins + fix activeIndex prop passed to sidebar.
* fix: viewer height
Now in a shared container w/ top bar, so we need to factor that in when calculating height
* lock file latest
* Update thumbnails if studies has changes
* bump cornerstone version to resolve globalToolSynch history issue
* Default panel to open; studies optional
* Bump minor version for ohif-cornestone-extension
* Simplify button logic
* Accommodate odd roundedButtonGroup value change emit
* Map viewers + selectedViewport instead of pulling off the window
2019-07-04 14:09:13 -04:00
..
latest feat: extension panels 2019-07-04 14:09:13 -04:00
v1 Collective changes since fork 2019-05-13 14:19:33 -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