diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 000000000..ae680f423 --- /dev/null +++ b/.eslintignore @@ -0,0 +1,4 @@ +config/** +docs/** +img/** +StandaloneViewer/** diff --git a/.eslintrc.js b/.eslintrc.js new file mode 100644 index 000000000..ac63643c5 --- /dev/null +++ b/.eslintrc.js @@ -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', + } +}; diff --git a/.gitignore b/.gitignore index 15c10e783..821c0305a 100644 --- a/.gitignore +++ b/.gitignore @@ -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 \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..f8a898044 --- /dev/null +++ b/docs/README.md @@ -0,0 +1 @@ +{% include "./SUMMARY.md" %} diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md new file mode 100644 index 000000000..e830cf2d8 --- /dev/null +++ b/docs/SUMMARY.md @@ -0,0 +1,6 @@ +# OHIF Viewers + +- [Installation](installation.md) +- Essentials + - [Getting Started](essentials/getting-started.md) +- [Contributing](contributing.md) diff --git a/docs/assets/CNAME b/docs/assets/CNAME new file mode 100644 index 000000000..b6d936979 --- /dev/null +++ b/docs/assets/CNAME @@ -0,0 +1 @@ +docs.ohif.org diff --git a/docs/book.json b/docs/book.json new file mode 100644 index 000000000..7b4110611 --- /dev/null +++ b/docs/book.json @@ -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 + } + } +} diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 000000000..378f7e2d3 --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,3 @@ +# Contributing + +... diff --git a/docs/essentials/getting-started.md b/docs/essentials/getting-started.md new file mode 100644 index 000000000..b868eed89 --- /dev/null +++ b/docs/essentials/getting-started.md @@ -0,0 +1,3 @@ +# Getting Started + +... \ No newline at end of file diff --git a/docs/installation.md b/docs/installation.md new file mode 100644 index 000000000..8cb9149a0 --- /dev/null +++ b/docs/installation.md @@ -0,0 +1,3 @@ +# Installation + +... \ No newline at end of file diff --git a/docs/package.json b/docs/package.json new file mode 100644 index 000000000..0a0b07291 --- /dev/null +++ b/docs/package.json @@ -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" + } +} diff --git a/docs/update-docs.sh b/docs/update-docs.sh new file mode 100644 index 000000000..28b2bc623 --- /dev/null +++ b/docs/update-docs.sh @@ -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