ohif-viewer/platform/docs
2021-06-15 19:12:47 -04:00
..
blog Initial docusaurus commit 2021-06-15 11:50:38 -04:00
docs working docs v2 before versioning 2021-06-15 19:11:09 -04:00
src docs v1 before versioning 2021-06-15 15:54:55 -04:00
static Initial docusaurus commit 2021-06-15 11:50:38 -04:00
versioned_docs versioned docs v2 2021-06-15 19:12:47 -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 working docs v2 before versioning 2021-06-15 19:11:09 -04:00
package.json versioned docs v1, and moved docs v2 2021-06-15 16:38:40 -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
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.