ohif-viewer/platform/docs
Alireza 5c8ee7f906
feat: OHIF-v3 UI Component Library (#2653)
* wip on storybook as a replacement for using UI components in docusaurus, since it causes too many problems

* fix: storybook webpack config

* feat: add more stories

* feat: add more stories

* feat: add more stories

* feat: fix logo and babel runtime error

* feat: move to mdx docs for ui

* feat: enhanced mdx for header and styles

* feat: Add button usecases

* feat: Add buttonGroup docs

* feat: Add docs and use case to cine and contex menu

* feat: fix decorators

* feat: add header and dropdown docs

* feat: add Icon and input docs

* feat: add more docs

* feat: add more stories

* fix: feedback section

* feat: Add doc page

* feat: Add typography and color stories

* yarn lock

* add analytics to v3-ui

* new banner image

* new viewport component

* update review comments
2022-02-10 14:08:34 -05:00
..
docs feat: OHIF-v3 UI Component Library (#2653) 2022-02-10 14:08:34 -05:00
src feat: Cornerstone extension viewport default enabledElement handler and installation guides (#2636) 2021-12-20 14:34:51 -05: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 fix: Footer logo for docs page 2021-08-31 10:30:53 -04:00
netlify.toml fix: setting hotkeys was broken (#2496) 2021-07-29 21:57:58 +02:00
package.json feat: Cornerstone extension viewport default enabledElement handler and installation guides (#2636) 2021-12-20 14:34:51 -05: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.