ohif-viewer/platform/docs
Alireza 46c2dc285c
feat: Add mode validity for the base viewer (#2525)
* feat: Add mode validity for the base viewer

* feat: Edit documentation and remove unnecessary files

* feat: Add probe tool documentation

* docs: Improved screenshots annotations

* Added new screenshot for measurements
2021-08-30 09:36:05 -04:00
..
docs feat: Add mode validity for the base viewer (#2525) 2021-08-30 09:36:05 -04:00
src feat: Add mode validity for the base viewer (#2525) 2021-08-30 09:36:05 -04:00
static feat: Add mode validity for the base viewer (#2525) 2021-08-30 09:36:05 -04:00
versioned_docs docs: Remove UI components for now, we will use Storybook instead later. Clean up links and introduction. (#2520) 2021-08-24 17:53:03 -04:00
versioned_sidebars versioned docs v2 2021-06-15 19:12:47 -04:00
.gitignore Initial docusaurus commit 2021-06-15 11:50:38 -04:00
babel.config.js Initial docusaurus commit 2021-06-15 11:50:38 -04:00
docusaurus.config.js feat: Add mode validity for the base viewer (#2525) 2021-08-30 09:36:05 -04:00
netlify.toml fix: setting hotkeys was broken (#2496) 2021-07-29 21:57:58 +02:00
package.json docs: Remove UI components for now, we will use Storybook instead later. Clean up links and introduction. (#2520) 2021-08-24 17:53:03 -04:00
pluginOHIFWebpackConfig.js docs: Remove UI components for now, we will use Storybook instead later. Clean up links and introduction. (#2520) 2021-08-24 17:53:03 -04:00
README.md Initial docusaurus commit 2021-06-15 11:50:38 -04:00
sidebars.js Initial docusaurus commit 2021-06-15 11:50:38 -04:00
tailwind.config.js docs: Remove UI components for now, we will use Storybook instead later. Clean up links and introduction. (#2520) 2021-08-24 17:53:03 -04:00
versions.json versioned docs v2 2021-06-15 19:12:47 -04:00

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

yarn install

Local Development

yarn start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

yarn build

This command generates static content into the build directory and can be served using any static contents hosting service.

Deployment

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.