Begin adding Gitbook for Viewers documentation

This commit is contained in:
Erik Ziegler 2018-01-29 15:01:58 +01:00
parent b417c417b7
commit 561dcd0969
12 changed files with 111 additions and 1 deletions

4
.eslintignore Normal file
View File

@ -0,0 +1,4 @@
config/**
docs/**
img/**
StandaloneViewer/**

16
.eslintrc.js Normal file
View File

@ -0,0 +1,16 @@
module.exports = {
'env': {
'browser': true,
'es6': true,
'jquery': true,
'node': true,
'mocha': true
},
'extends': 'eslint:recommended',
'parserOptions': {
'sourceType': 'module'
},
'rules': {
'no-undef': 'error',
}
};

3
.gitignore vendored
View File

@ -1,5 +1,4 @@
.idea/
docs/
.meteor/local
.meteor/meteorite
.meteor/dev_bundle
@ -9,3 +8,5 @@ node_modules
npm-debug.log
Packages/active-entry/helloworld/
LesionTracker/tests/nightwatch/reports/
package-lock.json
docs/_book

1
docs/README.md Normal file
View File

@ -0,0 +1 @@
{% include "./SUMMARY.md" %}

6
docs/SUMMARY.md Normal file
View File

@ -0,0 +1,6 @@
# OHIF Viewers
- [Installation](installation.md)
- Essentials
- [Getting Started](essentials/getting-started.md)
- [Contributing](contributing.md)

1
docs/assets/CNAME Normal file
View File

@ -0,0 +1 @@
docs.ohif.org

25
docs/book.json Normal file
View File

@ -0,0 +1,25 @@
{
"title": "OHIF",
"gitbook": ">3.0.0",
"plugins": [
"edit-link",
"theme-cornerstone",
"-fontsettings",
"github"
],
"pluginsConfig": {
"edit-link": {
"base": "https://github.com/OHIF/Viewers/edit/master/docs",
"label": "Edit This Page"
},
"github": {
"url": "https://github.com/OHIF/Viewers"
}
},
"links": {
"sharing": {
"facebook": false,
"twitter": false
}
}
}

3
docs/contributing.md Normal file
View File

@ -0,0 +1,3 @@
# Contributing
...

View File

@ -0,0 +1,3 @@
# Getting Started
...

3
docs/installation.md Normal file
View File

@ -0,0 +1,3 @@
# Installation
...

38
docs/package.json Normal file
View File

@ -0,0 +1,38 @@
{
"name": "ohif-viewers-docs",
"version": "1.0.0",
"description": "Open Health Imaging Foundation Viewers Metarepo for documentation",
"main": ".eslintrc.js",
"directories": {
"doc": "docs"
},
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1",
"docs": "gitbook install && gitbook serve",
"docs:deploy": "bash ./update-docs.sh"
},
"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-edit-link": "^2.0.2",
"gitbook-plugin-github": "^3.0.0"
}
}

9
docs/update-docs.sh Normal file
View File

@ -0,0 +1,9 @@
rm -rf _book
gitbook install
gitbook build
cp assets/CNAME _book/CNAME
cd _book
git init
git add -A
git commit -m 'update book'
git push -f git@github.com:OHIF/Viewers/.git master:gh-pages