docs v1 before versioning
This commit is contained in:
Alireza
parent
572b6d40b5
commit
6e9381860b
4
platform/docs/docs/I-want-to/_category_.json
Normal file
4
platform/docs/docs/I-want-to/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "I Want to ...",
|
||||
"position": 8
|
||||
}
|
||||
@ -11,17 +11,17 @@ If you would like to add SVG logo to header please follow these steps.
|
||||
* headerClasses: the list of classes which will be applied to header element
|
||||
* brandHref: the url of the logo to link
|
||||
|
||||
{% raw %}
|
||||
|
||||
``` html
|
||||
{{#header headerClasses="header-big bg-blue" brandHref="your logo link"}}
|
||||
...
|
||||
{{/header}}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
3. Create a section called as **brand** in **header** content block and add your logo content which is displayed on the left side of the header as default into section **brand**.
|
||||
|
||||
{% raw %}
|
||||
1. Create a section called as **brand** in **header** content block and add your logo content which is displayed on the left side of the header as default into section **brand**.
|
||||
|
||||
|
||||
``` html
|
||||
{{#header}}
|
||||
{{#section "brand"}}
|
||||
@ -35,6 +35,6 @@ If you would like to add SVG logo to header please follow these steps.
|
||||
{{/section}}
|
||||
{{/header}}
|
||||
```
|
||||
{% endraw %}
|
||||
|
||||
|
||||
For example, see how it works in [OHIF Viewer](https://github.com/OHIF/Viewers/blob/master/OHIFViewer/client/components/ohifViewer/ohifViewer.html#L2)
|
||||
|
||||
@ -1,2 +0,0 @@
|
||||
|
||||
This folder contains the OHIF Viewer installation instructions, categorized by operating system
|
||||
@ -1,2 +0,0 @@
|
||||
|
||||
This folder contains the OHIF Viewer installation instructions on the Microsoft Windows operating system
|
||||
@ -1,2 +0,0 @@
|
||||
|
||||
This folder contains the OHIF Viewer documentation
|
||||
4
platform/docs/docs/OHIF-Viewer/_category_.json
Normal file
4
platform/docs/docs/OHIF-Viewer/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Extras",
|
||||
"position": 13
|
||||
}
|
||||
@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Development Environment Installation
|
||||
---
|
||||
|
||||
**Development Environment Installation (Ubuntu)**
|
||||
|
||||
**CONFIDENTIAL DOCUMENT**
|
||||
@ -58,7 +62,7 @@ sudo apt-get update
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
2. Install packages to allow apt to use a repository over HTTPS, by running the following command:
|
||||
|
||||
@ -66,7 +70,7 @@ sudo apt-get install apt-transport-https ca-certificates curl software-propertie
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
3. Add Docker’s official GPG key, by running the following command:
|
||||
|
||||
@ -74,7 +78,7 @@ curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. Verify that you now have the key with the fingerprint **9DC8 5822 9FC7 DD38 854A E2D8 8D81 803C 0EBF CD88**, by searching for the last 8 characters of the fingerprint after running the following command:
|
||||
|
||||
@ -82,15 +86,15 @@ sudo apt-key fingerprint 0EBFCD88
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
5. Use the following command to set up the stable repository.
|
||||
5. Use the following command to set up the stable repository.
|
||||
|
||||
sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
6. Install the latest version of Docker CE, by running the following command:
|
||||
|
||||
@ -98,7 +102,7 @@ sudo apt-get install docker-ce
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
7. Verify that Docker CE is installed correctly by running the hello-world image:
|
||||
|
||||
@ -106,7 +110,7 @@ sudo docker run hello-world
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
**Note**: Additional information about Docker installation on Linux Ubuntu OS can be foud at [https://docs.docker.com/install/linux/docker-ce/ubuntu/](https://docs.docker.com/install/linux/docker-ce/ubuntu/).
|
||||
|
||||
@ -138,21 +142,18 @@ To install Dcm4che, follow the instructions below:
|
||||
|
||||
docker-compose.env
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>STORAGE_DIR=/storage/fs1
|
||||
```
|
||||
STORAGE_DIR=/storage/fs1
|
||||
POSTGRES_DB=pacsdb
|
||||
POSTGRES_USER=pacs
|
||||
POSTGRES_PASSWORD=pacs</td>
|
||||
</tr>
|
||||
</table>
|
||||
POSTGRES_PASSWORD=pacs
|
||||
```
|
||||
|
||||
|
||||
docker-compose.yml
|
||||
|
||||
<table>
|
||||
<tr>
|
||||
<td>version: "3"
|
||||
```
|
||||
version: "3"
|
||||
services:
|
||||
ldap:
|
||||
image: dcm4che/slapd-dcm4chee:2.4.44-14.1
|
||||
@ -205,21 +206,19 @@ volumes:
|
||||
- /etc/timezone:/etc/timezone:ro
|
||||
- ~/dcm4chee-arc/wildfly:/opt/wildfly/standalone
|
||||
- ~/dcm4chee-arc/storage:/storage</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
```
|
||||
|
||||
Files/Folder will become like the image above:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
3. Open a terminal inside DCM4CHE folder, and run the following command:
|
||||
1. Open a terminal inside DCM4CHE folder, and run the following command:
|
||||
|
||||
sudo snap install docker
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. Still inside the DCM4CHE folder, run the following command:
|
||||
|
||||
@ -227,7 +226,7 @@ sudo docker-compose -p dcm4chee up -d
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
1. The following commands can be used to control DCM4CHE:
|
||||
|
||||
@ -239,19 +238,19 @@ Stop and delete all 3 containers: docker-compose -p dcm4chee down
|
||||
|
||||
2. Now it is necessary to import some DICOM studies to DCM4CHE. Before importing these studies, you will need to download them. To do so, access the address [http://34.224.187.57:3000/studylist](http://34.224.187.57:3000/studylist), right click one or more studies, and select the option Export:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
3. Confirm the study export on the modal window that will appear:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
4. The study(ies) export will begin. You can follow the exporting progress:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
5. After the exporting progress, the study(ies) will be downloaded in a file called "studies.zip". Create a folder named “Studies” on your Home folder, and extract this and any other studies you download in this folder:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
6. Open the terminal, go to the DCM4CHE folder, and run the following command in order to send the studies to DCM4CHE:
|
||||
|
||||
@ -259,15 +258,15 @@ docker run -v ~/Studies/:/tmp --rm --network=dcm4chee_default dcm4che/dcm4che-to
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
7. Now, go to your browser and access the URL [http://localhost:8080/dcm4chee-arc/ui2/](http://localhost:8080/dcm4chee-arc/ui2/). Once opened, click on the refresh icon on the most right:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
8. The studies received by DCM4CHE will be shown:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
9. Open the terminal, go to your Home folder, and run the following command in order to clone viewers repository to your local:
|
||||
|
||||
@ -275,7 +274,7 @@ git clone https://github.com/OHIF/Viewers.git
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
10. Then, enter the Viewers folder, and run the following command in order to make sure that you are in master branch:
|
||||
|
||||
@ -283,7 +282,7 @@ git checkout master
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
11. Now go to OHIFViewer folder and run the following command:
|
||||
|
||||
@ -291,7 +290,7 @@ meteor npm install
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
12. Still on the OHIFViewer folder, run the following command:
|
||||
|
||||
@ -299,15 +298,15 @@ Expected result:
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
13. Now, go to your browser and access the URL [http://localhost:3000](http://localhost:3000). Once opened, change the Study Date filter to start on the year 2000:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
14. The imported studies will be show. Double click a study to open it:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
## Meteor
|
||||
|
||||
@ -323,7 +322,7 @@ curl https://install.meteor.com/ | sh
|
||||
|
||||
Expected result:
|
||||
|
||||
|
||||
<!--  -->
|
||||
|
||||
## Starting OHIF Viewer after system restart
|
||||
|
||||
@ -343,53 +342,4 @@ docker-compose -p dcm4chee start
|
||||
|
||||
./bin/dcm4cheeDICOMWeb.sh
|
||||
|
||||
6. Access the address [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
6. Access the address [http://localhost:3000](http://localhost:3000)
|
||||
|
||||
@ -1,3 +1,7 @@
|
||||
---
|
||||
title: Standalone Viewer
|
||||
---
|
||||
|
||||
# Standalone Viewer
|
||||
|
||||
## Quick Start
|
||||
@ -1,3 +1,9 @@
|
||||
---
|
||||
id: OHIF-v1 Documentation
|
||||
slug: /
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
##### Looking for your Deploy Preview? - <a onclick="function redirect() { window.location.href='/demo/'; } redirect();">Deploy Preview for Viewer</a>
|
||||
|
||||
# Introduction
|
||||
@ -8,18 +14,18 @@ This documentation concerns the OHIF framework itself and its three example appl
|
||||
|
||||
## The **OHIF Viewer**: A general purpose DICOM Viewer ([demo](http://viewer.ohif.org/))
|
||||
|
||||
|
||||
|
||||
|
||||
The Open Health Imaging Foundation intends to provide a simple general purpose DICOM Viewer which can be easily extended for specific uses. The primary purpose of the OHIF Viewer is to serve as a testing ground for the underlying packages and the [Cornerstone](https://cornerstonejs.org/) family of libraries.
|
||||
|
||||
## **Lesion Tracker**: An oncology-focused imaging application ([demo](http://lesiontracker.ohif.org/))
|
||||
|
||||
|
||||
|
||||
|
||||
The Lesion Tracker is designed to facilitate quantitative assessments of tumour burden over time. It is similar in scope to the ePAD Imaging Platform (https://epad.stanford.edu/), developed at Stanford Medicine.
|
||||
|
||||
## Study List & DICOM Connectivity
|
||||
|
||||
|
||||
|
||||
The solution provides a study list and other resources for connecting to PACS and other Image Archives through standard communication approaches (DICOM Web, DICOM Messages).
|
||||
|
||||
|
||||
@ -1,61 +0,0 @@
|
||||
# OHIF Viewers
|
||||
|
||||
- Essentials
|
||||
- [Installation](essentials/installation.md)
|
||||
- [Getting Started](essentials/getting-started.md)
|
||||
- [Architecture](essentials/architecture.md)
|
||||
- [Configuration](essentials/configuration.md)
|
||||
- [Troubleshooting](essentials/troubleshooting.md)
|
||||
- Connecting to Image Archives
|
||||
- [What are my options?](connecting-to-image-archives/options.md)
|
||||
- [DICOM Web](connecting-to-image-archives/dicomweb.md)
|
||||
- [DICOM Message Service Element](connecting-to-image-archives/dimse.md)
|
||||
- Examples
|
||||
- [dcm4chee w/ Docker](connecting-to-image-archives/dcm4chee-with-docker.md)
|
||||
- [Orthanc w/ Docker](connecting-to-image-archives/orthanc-with-docker.md)
|
||||
- [Google Cloud Healthcare](connecting-to-image-archives/google-cloud-healthcare.md)
|
||||
- [Osirix](connecting-to-image-archives/osirix.md)
|
||||
- Data Organization
|
||||
- [Data Hierarchy](data/data-hierarchy.md)
|
||||
- [Image Viewport](data/image-viewport.md)
|
||||
- Viewport Layout
|
||||
- [Layout Management](layout/layout-management.md)
|
||||
- [Hanging Protocols](layout/hanging-protocols.md)
|
||||
- Packages
|
||||
- [Measurements Package (ohif-measurements)](packages/measurements.md)
|
||||
- Deployment
|
||||
- [Building for Production](deployment/building-for-production.md)
|
||||
- [Security](deployment/security.md)
|
||||
- I Want To...
|
||||
- [Add a Tool to the Viewer](I-want-to/add-a-tool-to-the-viewer.md)
|
||||
- [Add a Logo to the Viewer](I-want-to/add-a-logo-to-the-viewer.md)
|
||||
----
|
||||
|
||||
- Example Applications
|
||||
- [OHIF Viewer](example-applications/ohif-viewer.md)
|
||||
- [Lesion Tracker](example-applications/lesion-tracker.md)
|
||||
- [Standalone Viewer](example-applications/standalone-viewer.md)
|
||||
|
||||
----
|
||||
- Standalone Viewer Integration
|
||||
- [Usage](standalone-viewer/usage.md)
|
||||
|
||||
----
|
||||
- Lesion Tracker
|
||||
- [User Manual](lesion-tracker/user-manual.md)
|
||||
- [Installation on Windows](lesion-tracker/installation-on-windows.md)
|
||||
- [Manage Studies in Orthanc](lesion-tracker/manage-studies-in-orthanc.md)
|
||||
- [User Accounts](lesion-tracker/user-accounts.md)
|
||||
- [Study and Timepoint Management](lesion-tracker/study-and-timepoint-management.md)
|
||||
- [Using the Viewer](lesion-tracker/using-the-viewer.md)
|
||||
- [User Preferences](lesion-tracker/user-preferences.md)
|
||||
- [Server Management](lesion-tracker/server-management.md)
|
||||
- [Audit Trail](lesion-tracker/audit-trail.md)
|
||||
|
||||
----
|
||||
- FAQ
|
||||
- [General](faq/general.md)
|
||||
- [Technical](faq/technical.md)
|
||||
|
||||
----
|
||||
- [Contributing](contributing.md)
|
||||
@ -1 +0,0 @@
|
||||
docs.ohif.org
|
||||
@ -1,54 +0,0 @@
|
||||
{
|
||||
"title": "OHIF",
|
||||
"description": "Documentation for the OHIF framework",
|
||||
"gitbook": ">3.0.0",
|
||||
"plugins": [
|
||||
"edit-link",
|
||||
"theme-cornerstone",
|
||||
"-fontsettings",
|
||||
"github",
|
||||
"ga",
|
||||
"sitemap",
|
||||
"anchors",
|
||||
"versions"
|
||||
],
|
||||
"pluginsConfig": {
|
||||
"edit-link": {
|
||||
"base": "https://github.com/OHIF/Viewers/edit/master/docs",
|
||||
"label": "Edit This Page"
|
||||
},
|
||||
"github": {
|
||||
"url": "https://github.com/OHIF/Viewers"
|
||||
},
|
||||
"ga": {
|
||||
"token": "UA-110573590-2"
|
||||
},
|
||||
"sitemap": {
|
||||
"hostname": "https://docs.ohif.org"
|
||||
},
|
||||
"versions": {
|
||||
"gitbookConfigURL": "https://raw.githubusercontent.com/OHIF/Viewers/master/docs/book.json",
|
||||
"options": [
|
||||
{
|
||||
"value": "https://docs.ohif.org/history/v1/",
|
||||
"text": "Version 1.0.0 (Meteor)",
|
||||
"selected": true
|
||||
},
|
||||
{
|
||||
"value": "https://docs.ohif.org/history/v2/",
|
||||
"text": "Version 2.0.0"
|
||||
},
|
||||
{
|
||||
"value": "https://docs.ohif.org/",
|
||||
"text": "Version 3.0.0"
|
||||
}
|
||||
]
|
||||
}
|
||||
},
|
||||
"links": {
|
||||
"sharing": {
|
||||
"facebook": false,
|
||||
"twitter": false
|
||||
}
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Connecting to ImageArchives",
|
||||
"position": 3
|
||||
}
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
# DCM4CHEE with Docker
|
||||
|
||||
1. Install Docker (https://www.docker.com/)
|
||||
@ -18,24 +21,24 @@
|
||||
|
||||
3. Run the OHIF Viewer or Lesion Tracker using the dcm4cheeDIMSE.json configuration file
|
||||
|
||||
````bash
|
||||
cd OHIFViewer
|
||||
PACKAGE_DIRS="../Packages" meteor --settings ../config/dcm4cheeDIMSE.json
|
||||
````
|
||||
````bash
|
||||
cd OHIFViewer
|
||||
PACKAGE_DIRS="../Packages" meteor --settings ../config/dcm4cheeDIMSE.json
|
||||
````
|
||||
|
||||
## Web Service URLs from DCM4CHEE:
|
||||
Original source here: https://github.com/dcm4che/dcm4chee-arc-light/wiki/Running-on-Docker#web-service-urls
|
||||
|
||||
> - Archive UI: <http://localhost:8080/dcm4chee-arc/ui> - if secured, login with
|
||||
- Archive UI: <http://localhost:8080/dcm4chee-arc/ui> - if secured, login with
|
||||
|
||||
> Username | Password | Role
|
||||
> --- | --- | ---
|
||||
> `user` | `user` | `user`
|
||||
> `admin` | `admin` | `user` + `admin`
|
||||
> - Keycloak Administration Console: <http://localhost:8080/auth>, login with Username: `admin`, Password: `admin`.
|
||||
> - Wildfly Administration Console: <http://localhost:9990>, login with Username: `admin`, Password: `admin`.
|
||||
> - Kibana UI: <http://localhost:5601>
|
||||
> - DICOM QIDO-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
> - DICOM STOW-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
> - DICOM WADO-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
> - DICOM WADO-URI: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/wado>
|
||||
Username | Password | Role
|
||||
--- | --- | ---
|
||||
`user` | `user` | `user`
|
||||
`admin` | `admin` | `user` + `admin`
|
||||
- Keycloak Administration Console: <http://localhost:8080/auth>, login with Username: `admin`, Password: `admin`.
|
||||
- Wildfly Administration Console: <http://localhost:9990>, login with Username: `admin`, Password: `admin`.
|
||||
- Kibana UI: <http://localhost:5601>
|
||||
- DICOM QIDO-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
- DICOM STOW-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
- DICOM WADO-RS Base URL: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/rs>
|
||||
- DICOM WADO-URI: <http://localhost:8080/dcm4chee-arc/aets/DCM4CHEE/wado>
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# DICOM Web
|
||||
|
||||
[DICOMWeb](https://en.wikipedia.org/wiki/DICOMweb) refers to RESTful DICOM Services and is a recently standardized set of guidelines for exchanging medical images and imaging metadata over the internet. Not all archives fully support it yet, but it is gaining wider adoption.
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
# DICOM Message Service Element
|
||||
|
||||
DIMSE Stands for [DICOM Message Service Element](http://dicom.nema.org/medical/dicom/current/output/chtml/part07/chapter_7.html) and is the standard method through which DICOM archives communicate. We support this messaging standard for the retrieval of study, series, and instance metadata because it is widely support. For certain PACS systems, it also (currently) provides faster query results than DICOMWeb.
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
# Google Cloud Healthcare
|
||||
|
||||
> The [Google Cloud Healthcare API](https://cloud.google.com/healthcare/) is a powerful option for storing medical imaging data in the cloud.
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Connecting to Image Archives
|
||||
|
||||
We support DIMSE and DICOMWeb. Which one to use is up to you and depends on your PACS system. DICOMWeb requires no setup on the PACS-side whatsoever, whereas DIMSE may require you to add the 'OHIFDCM' aeTitle to the known DICOM Modalities of your Archive. This is the case for Orthanc, for example (See https://github.com/OHIF/Viewers/wiki/Orthanc-with-DIMSE).
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
# Orthanc with Docker
|
||||
|
||||
Depending on whether or not you want uploaded studies to persist in Orthanc after Docker has been closed, there are two different methods for starting the Docker image:
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
# Example: Osirix
|
||||
|
||||
...
|
||||
@ -1,3 +1,7 @@
|
||||
---
|
||||
id: contributing
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Contributing
|
||||
|
||||
### I would like to contribute code - how do I do this?
|
||||
|
||||
4
platform/docs/docs/data/_category_.json
Normal file
4
platform/docs/docs/data/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Data Organization",
|
||||
"position": 4
|
||||
}
|
||||
4
platform/docs/docs/deployment/_category_.json
Normal file
4
platform/docs/docs/deployment/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Deployment",
|
||||
"position": 7
|
||||
}
|
||||
4
platform/docs/docs/essentials/_category_.json
Normal file
4
platform/docs/docs/essentials/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Essentials",
|
||||
"position": 2
|
||||
}
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Architecture
|
||||
|
||||
## Meteor
|
||||
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
# Configurations
|
||||
|
||||
There are a few pre-defined settings files that you can find in [config](https://github.com/OHIF/Viewers/tree/master/config) folder. These are Meteor files and all settings can be accessed as showed on [Meteor Website](https://docs.meteor.com/api/core.html#Meteor-settings). UI settings are also available as OHIF.uiSettings. See the [schema](https://github.com/OHIF/Viewers/blob/131d64854cb2eceff056a15ccb12c34b9e2baaa7/Packages/ohif-servers/both/schema/servers.js) for more information.
|
||||
|
||||
@ -1,3 +0,0 @@
|
||||
# Getting Started
|
||||
|
||||
...
|
||||
@ -1,3 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Installation
|
||||
|
||||
## Getting the Code
|
||||
@ -18,13 +21,19 @@ or [Download the latest Master as a ZIP File](https://github.com/OHIF/Viewers/ar
|
||||
|
||||
#### Open Source DICOM Image Archive Options
|
||||
|
||||
Archive | Installation
|
||||
-------------------------------------------|
|
||||
[DCM4CHEE Archive 5.x](https://github.com/dcm4che/dcm4chee-arc-light) | [Installation with Docker](https://github.com/dcm4che/dcm4chee-arc-light/wiki/Running-on-Docker)
|
||||
[Orthanc](https://www.orthanc-server.com/) | [Installation with Docker](http://book.orthanc-server.com/users/docker.html)
|
||||
[DICOMcloud](https://github.com/DICOMcloud/DICOMcloud) (**DICOM Web only**)| [Installation](https://github.com/DICOMcloud/DICOMcloud#running-the-code)
|
||||
[OsiriX](http://www.osirix-viewer.com/) (**Mac OSX only**) |
|
||||
[Horos](https://www.horosproject.org/) (**Mac OSX only**) |
|
||||
|
||||
|
||||
| Archive | Installation |
|
||||
| ----------- | ----------- |
|
||||
| [DCM4CHEE Archive 5.x](https://github.com/dcm4che/dcm4chee-arc-light) | [Installation with Docker](https://github.com/dcm4che/dcm4chee-arc-light/wiki/Running-on-Docker) |
|
||||
| [Orthanc](https://www.orthanc-server.com/) | [Installation with Docker](http://book.orthanc-server.com/users/docker.html) |
|
||||
| [DICOMcloud](https://github.com/DICOMcloud/DICOMcloud) (**DICOM Web only**) | [Installation](https://github.com/DICOMcloud/DICOMcloud#running-the-code) |
|
||||
| [OsiriX](http://www.osirix-viewer.com/) (**Mac OSX only**) | Text |
|
||||
| [Horos](https://www.horosproject.org/) (**Mac OSX only**) | Text |
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*Feel free to make a Pull Request if you want to add to this list.*
|
||||
|
||||
|
||||
@ -1,12 +1,17 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
# Troubleshooting
|
||||
|
||||
## Common Problems
|
||||
|
||||
Problem | Most Common Reasons
|
||||
--------|--------------------
|
||||
** Can't retrieve Study List over DICOMWeb** | 1. QIDO root URL is incorrect<br> 2. DICOM Web is not enabled on PACS
|
||||
** Can't retrieve Study List over DIMSE** | 1. PACS is not configured to allow connections from OHIF Meteor Server
|
||||
** Can't retrieve images** | 1. WADO Root URL is incorrect<br> 2. DICOM Web is not enabled on PACS<br> 3. HTTP Basic Authentication username and password are incorrect or not provided.
|
||||
| Problem | Most Common Reasons |
|
||||
| --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| Can't retrieve Study List over DICOMWeb | 1. QIDO root URL is incorrect 2. DICOM Web is not enabled on PACS |
|
||||
| Can't retrieve Study List over DIMSE | 1. PACS is not configured to allow connections from OHIF Meteor Server |
|
||||
| Can't retrieve images | 1. WADO Root URL is incorrect 2. DICOM Web is not enabled on PACS 3. HTTP Basic Authentication username and password are incorrect or not provided. |
|
||||
|
||||
|
||||
|
||||
## Debugging Steps
|
||||
### Can't retrieve Study List over DICOMWeb
|
||||
|
||||
4
platform/docs/docs/example-applications/_category_.json
Normal file
4
platform/docs/docs/example-applications/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Example Applications",
|
||||
"position": 9
|
||||
}
|
||||
4
platform/docs/docs/faq/_category_.json
Normal file
4
platform/docs/docs/faq/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "FAQ",
|
||||
"position": 12
|
||||
}
|
||||
@ -1,4 +1,4 @@
|
||||
# Frequently Asked Questions - General
|
||||
# General
|
||||
|
||||
### How do I file a bug?
|
||||
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
# Frequently Asked Questions - Technical
|
||||
# Technical
|
||||
## Why is your framework built with Meteor?
|
||||
|
||||
At the time of project conception, Meteor was a simple way to begin using bleeding edge web technologies without putting significant effort into configuration and build processes. Although Meteor does have some drawbacks, it remains a simple all-in-one solution.
|
||||
|
||||
@ -1,35 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[new.docusaurus.io](https://new.docusaurus.io)**.
|
||||
|
||||
## Generate a new site
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**:
|
||||
|
||||
```shell
|
||||
npx @docusaurus/init@latest init my-website classic
|
||||
```
|
||||
|
||||
## Start your site
|
||||
|
||||
Run the development server:
|
||||
|
||||
```shell
|
||||
cd my-website
|
||||
|
||||
npx docusaurus start
|
||||
```
|
||||
|
||||
Your site starts at `http://localhost:3000`.
|
||||
|
||||
Open `docs/intro.md` and edit some lines: the site **reloads automatically** and display your changes.
|
||||
4
platform/docs/docs/layout/_category_.json
Normal file
4
platform/docs/docs/layout/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Viewport Layout",
|
||||
"position": 5
|
||||
}
|
||||
4
platform/docs/docs/lesion-tracker/_category_.json
Normal file
4
platform/docs/docs/lesion-tracker/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Lesion Tracker",
|
||||
"position": 11
|
||||
}
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Audit Trail
|
||||
---
|
||||
sidebar_position: 9
|
||||
---
|
||||
# Audit Trail
|
||||
|
||||
1. To view Audit Trails, select **View Audit Log** on the Configuration menu.
|
||||
2. To filter audit logs for a column or multiple columns, type or select in the
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Installation on Windows
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
# Installation on Windows
|
||||
On Windows, the easiest way to install LesionTracker is using the provided Windows Installer. You can download the latest version of LesionTracker installer from [OHIF](ohif.org)
|
||||
|
||||
## Install
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Manage Studies in Orthanc
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
# Manage Studies in Orthanc
|
||||
Orthanc is an open-source, simple and powerful standalone DICOM server which eases DICOM scripting and data management for clinical routine and medical research. LesionTracker installer installs Orthanc as a service and runs automatically in the background. Orthanc serves a web interface, Orthanc Explorer, and it can be accessed through http://localhost:8042 in your web browser or the Orthanc Server shortcut which is created by LesionTracker installer and loads http://localhost:8042 in your default browser.
|
||||
|
||||
## Upload a study into Orthanc using Orthanc Explorer
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Server Management
|
||||
---
|
||||
sidebar_position: 8
|
||||
---
|
||||
# Server Management
|
||||
|
||||
LesionTracker supports configuration of multiple servers and allows to switch between them. To configure the servers, click **Server Information** on the Configuration Menu.
|
||||
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Study and Timepoint Management
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
# Study and Timepoint Management
|
||||
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - User Accounts
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
# User Accounts
|
||||
|
||||
## Sign In
|
||||
|
||||
|
||||
@ -1,10 +0,0 @@
|
||||
# Lesion Tracker - User Manual
|
||||
|
||||
1. [Installation on Windows](../installation-on-windows.md)
|
||||
2. [Manage Studies in Orthanc](../manage-studies-in-orthanc.md)
|
||||
3. [User Accounts](../user-accounts.md)
|
||||
4. [Study and Timepoint Management](../study-and-timepoint-management.md)
|
||||
5. [Lesion Tracking](../lesion-tracking.md)
|
||||
6. [User Preferences](../user-preferences.md)
|
||||
7. [Server Management](../server-management.md)
|
||||
8. [Audit Trail](../audit-trail.md)
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - User Preferences
|
||||
---
|
||||
sidebar_position: 7
|
||||
---
|
||||
# User Preferences
|
||||
To view User Preferences dialog, select **Preferences** on the Configuration menu. User Preferences dialog includes a couple of tabs:
|
||||
|
||||
|
||||
|
||||
@ -1,4 +1,7 @@
|
||||
# Lesion Tracker - Using the Viewer
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
# Using the Viewer
|
||||
|
||||
After you double-click a study, the Lesion Tracking imaging application will be launched. The basic patient and study data is displayed in the Image Viewer.
|
||||
|
||||
|
||||
@ -1,44 +0,0 @@
|
||||
{
|
||||
"name": "ohif-viewer-v1-docs",
|
||||
"version": "1.0.0",
|
||||
"description": "Open Health Imaging Foundation Viewers Metarepo for documentation",
|
||||
"main": ".eslintrc.js",
|
||||
"directories": {
|
||||
"doc": "docs"
|
||||
},
|
||||
"scripts": {
|
||||
"docs": "gitbook install && gitbook serve"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "git+https://github.com/OHIF/Viewers.git"
|
||||
},
|
||||
"keywords": [
|
||||
"dicom",
|
||||
"cornerstone",
|
||||
"OHIF",
|
||||
"zero",
|
||||
"footprint",
|
||||
"medical",
|
||||
"imaging",
|
||||
"viewer"
|
||||
],
|
||||
"author": "Open Health Imaging Foundation",
|
||||
"license": "MIT",
|
||||
"bugs": {
|
||||
"url": "https://github.com/OHIF/Viewers/issues"
|
||||
},
|
||||
"homepage": "https://github.com/OHIF/Viewers#readme",
|
||||
"dependencies": {
|
||||
"gitbook-plugin-anchors": "^0.7.1",
|
||||
"gitbook-plugin-edit-link": "^2.0.2",
|
||||
"gitbook-plugin-ga": "^2.0.0",
|
||||
"gitbook-plugin-github": "^3.0.0",
|
||||
"gitbook-plugin-sitemap": "^1.2.0",
|
||||
"gitbook-plugin-theme-cornerstone": "^1.1.2",
|
||||
"gitbook-plugin-versions": "^2.1.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"gitbook-cli": "^2.3.2"
|
||||
}
|
||||
}
|
||||
4
platform/docs/docs/packages/_category_.json
Normal file
4
platform/docs/docs/packages/_category_.json
Normal file
@ -0,0 +1,4 @@
|
||||
{
|
||||
"label": "Packages",
|
||||
"position": 6
|
||||
}
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Tutorial - Basics",
|
||||
"position": 2
|
||||
}
|
||||
@ -1,21 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||
|
||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||
|
||||
## What's next?
|
||||
|
||||
- Read the [official documentation](https://docusaurus.io/).
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
@ -1,29 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create a Blog Post
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
author: Steven Hansel
|
||||
author_title: Docusaurus Contributor
|
||||
author_url: https://github.com/ShinteiMai
|
||||
author_image_url: https://github.com/ShinteiMai.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at `http://localhost:3000/blog/greetings`.
|
||||
@ -1,56 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create a Document
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
- **versioning**
|
||||
|
||||
## Create your first Doc
|
||||
|
||||
Create a markdown file at `docs/hello.md`:
|
||||
|
||||
```md title="docs/hello.md"
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
A new document is now available at `http://localhost:3000/docs/hello`.
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||
|
||||
Add metadatas to customize the sidebar label and position:
|
||||
|
||||
```diff title="docs/hello.md"
|
||||
+ ---
|
||||
+ sidebar_label: "Hi!"
|
||||
+ sidebar_position: 3
|
||||
+ ---
|
||||
|
||||
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
||||
|
||||
```diff title="sidebars.js"
|
||||
module.exports = {
|
||||
tutorialSidebar: [
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
- items: [...],
|
||||
+ items: ['hello'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
@ -1,43 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create a Page
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` -> `localhost:3000/`
|
||||
- `src/pages/foo.md` -> `localhost:3000/foo`
|
||||
- `src/pages/foo/bar.js` -> `localhost:3000/foo/bar`
|
||||
|
||||
## Create your first React Page
|
||||
|
||||
Create a file at `src/pages/my-react-page.js`:
|
||||
|
||||
```jsx title="src/pages/my-react-page.js"
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
|
||||
export default function MyReactPage() {
|
||||
return (
|
||||
<Layout>
|
||||
<h1>My React page</h1>
|
||||
<p>This is a React page</p>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
A new page is now available at `http://localhost:3000/my-react-page`.
|
||||
|
||||
## Create your first Markdown Page
|
||||
|
||||
Create a file at `src/pages/my-markdown-page.md`:
|
||||
|
||||
```mdx title="src/pages/my-markdown-page.md"
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at `http://localhost:3000/my-markdown-page`.
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
## Build your site
|
||||
|
||||
Build your site **for production**:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
The static files are generated in the `build` folder.
|
||||
|
||||
## Deploy your site
|
||||
|
||||
Test your production build locally:
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
The `build` folder is now served at `http://localhost:3000/`.
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
@ -1,144 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
|
||||
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
||||
|
||||
## Front Matter
|
||||
|
||||
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
||||
|
||||
```text title="my-doc.md"
|
||||
// highlight-start
|
||||
---
|
||||
id: my-doc-id
|
||||
title: My document title
|
||||
description: My document description
|
||||
slug: /my-custom-url
|
||||
---
|
||||
// highlight-end
|
||||
|
||||
## Markdown heading
|
||||
|
||||
Markdown text with [links](./hello.md)
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
Regular Markdown links are supported, using url paths or relative file paths.
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](/create-a-page).
|
||||
```
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](./create-a-page.md).
|
||||
```
|
||||
|
||||
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
||||
|
||||
## Images
|
||||
|
||||
Regular Markdown images are supported.
|
||||
|
||||
Add an image at `static/img/docusaurus.png` and display it in Markdown:
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Code Blocks
|
||||
|
||||
Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return (
|
||||
<h1>Hello, Docusaurus!</h1>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
## Admonitions
|
||||
|
||||
Docusaurus has a special syntax to create admonitions and callouts:
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
## MDX and React Components
|
||||
|
||||
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
||||
|
||||
```jsx
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`)
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
@ -1,4 +0,0 @@
|
||||
{
|
||||
"label": "Tutorial - Extras",
|
||||
"position": 3
|
||||
}
|
||||
@ -1,55 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Manage Docs Versions
|
||||
|
||||
Docusaurus can manage multiple versions of your docs.
|
||||
|
||||
## Create a docs version
|
||||
|
||||
Release a version 1.0 of your project:
|
||||
|
||||
```bash
|
||||
npm run docusaurus docs:version 1.0
|
||||
```
|
||||
|
||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
||||
|
||||
Your docs now have 2 versions:
|
||||
|
||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
||||
|
||||
## Add a Version Dropdown
|
||||
|
||||
To navigate seamlessly across versions, add a version dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'docsVersionDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The docs version dropdown appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Update an existing version
|
||||
|
||||
It is possible to edit versioned docs in their respective folder:
|
||||
|
||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
||||
@ -1,88 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Translate your site
|
||||
|
||||
Let's translate `docs/intro.md` to French.
|
||||
|
||||
## Configure i18n
|
||||
|
||||
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr'],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Translate a doc
|
||||
|
||||
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
||||
|
||||
```bash
|
||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
||||
|
||||
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
||||
```
|
||||
|
||||
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
||||
|
||||
## Start your localized site
|
||||
|
||||
Start your site on the French locale:
|
||||
|
||||
```bash
|
||||
npm run start -- --locale fr
|
||||
```
|
||||
|
||||
Your localized site is accessible at `http://localhost:3000/fr/` and the `Getting Started` page is translated.
|
||||
|
||||
:::caution
|
||||
|
||||
In development, you can only use one locale at a same time.
|
||||
|
||||
:::
|
||||
|
||||
## Add a Locale Dropdown
|
||||
|
||||
To navigate seamlessly across languages, add a locale dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The locale dropdown now appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Build your localized site
|
||||
|
||||
Build your site for a specific locale:
|
||||
|
||||
```bash
|
||||
npm run build -- --locale fr
|
||||
```
|
||||
|
||||
Or build your site to include all the locales at once:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
@ -1,9 +0,0 @@
|
||||
rm -rf _book
|
||||
gitbook install
|
||||
gitbook build
|
||||
cp assets/CNAME _book/CNAME
|
||||
cd _book
|
||||
git init
|
||||
git add -A
|
||||
git commit -m 'Update compiled GitBook (this commit is automatic)'
|
||||
git push -f git@github.com:OHIF/Viewers.git master:gh-pages
|
||||
@ -19,11 +19,11 @@ module.exports = {
|
||||
items: [
|
||||
{
|
||||
type: 'doc',
|
||||
docId: 'intro',
|
||||
docId: 'OHIF-v1 Documentation',
|
||||
position: 'left',
|
||||
label: 'Tutorial',
|
||||
},
|
||||
{ to: '/blog', label: 'Blog', position: 'left' },
|
||||
// { to: '/blog', label: 'Blog', position: 'left' },
|
||||
{
|
||||
href: 'https://github.com/facebook/docusaurus',
|
||||
label: 'GitHub',
|
||||
@ -82,6 +82,7 @@ module.exports = {
|
||||
'@docusaurus/preset-classic',
|
||||
{
|
||||
docs: {
|
||||
routeBasePath: "/",
|
||||
sidebarPath: require.resolve('./sidebars.js'),
|
||||
// Please change this to your repo.
|
||||
editUrl:
|
||||
|
||||
@ -1,40 +0,0 @@
|
||||
import React from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Layout from '@theme/Layout';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
import styles from './index.module.css';
|
||||
import HomepageFeatures from '../components/HomepageFeatures';
|
||||
|
||||
function HomepageHeader() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||
<div className="container">
|
||||
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||
<div className={styles.buttons}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/intro">
|
||||
Docusaurus Tutorial - 5min ⏱️
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Home() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
title={`Hello from ${siteConfig.title}`}
|
||||
description="Description will go into a meta tag in <head />">
|
||||
<HomepageHeader />
|
||||
<main>
|
||||
<HomepageFeatures />
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user