From 824f9e1371fb270cf7a6ccc0c144966529db80e4 Mon Sep 17 00:00:00 2001 From: Erik Ziegler Date: Tue, 13 Mar 2018 11:31:54 +0100 Subject: [PATCH] Fix issues with latest doc addition. Add Google Analytics, sitemap, anchors --- ...-viewer.md => add-a-logo-to-the-viewer.md} | 40 +++++++++---------- docs/SUMMARY.md | 2 +- docs/book.json | 12 +++++- docs/package.json | 4 +- 4 files changed, 33 insertions(+), 25 deletions(-) rename docs/I-want-to/{add-logo-to-the-viewer.md => add-a-logo-to-the-viewer.md} (73%) diff --git a/docs/I-want-to/add-logo-to-the-viewer.md b/docs/I-want-to/add-a-logo-to-the-viewer.md similarity index 73% rename from docs/I-want-to/add-logo-to-the-viewer.md rename to docs/I-want-to/add-a-logo-to-the-viewer.md index e1e7c6c55..ac76df0c3 100644 --- a/docs/I-want-to/add-logo-to-the-viewer.md +++ b/docs/I-want-to/add-a-logo-to-the-viewer.md @@ -1,44 +1,40 @@ -# Add Logo to the Viewer +# Add a Logo to the Viewer - -The OHIF Framework provides **[ohif-header](https://github.com/OHIF/Viewers/tree/master/Packages/ohif-header)** package to add a header into application layout. **ohif-header** package is designed as a [custom block helper](http://blazejs.org/api/spacebars.html#Custom-Block-Helpers) named **header** to define your own header context. +The OHIF Framework provides [**ohif-header**](https://github.com/OHIF/Viewers/tree/master/Packages/ohif-header) package to add a header into application layout. **ohif-header** package is designed as a [custom block helper](http://blazejs.org/api/spacebars.html#Custom-Block-Helpers) named **header** to define your own header context. If you would like to add SVG logo to header please follow these steps. - -1. Add your SVG logo into public folder. + +1. Add your SVG logo into public folder. 2. Add **header** content block which will be located on the top of the application layout into your application's main template. You can also pass some parameters to **header** content block to customize the header. * headerClasses: the list of classes which will be applied to header element * brandHref: the url of the logo to link - - ``` - {{#header headerClasses="header-big bg-blue" brandHref="your logo link"}} - - .... - - {{/header}} +{% 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 %} + ``` html {{#header}} - {{#section 'brand'}} - .... - + {{#section "brand"}} - +
Logo Text
- - .... {{/section}} {{/header}} ``` - - For example, see how it works in [OHIF Viewer](https://github.com/OHIF/Viewers/blob/master/OHIFViewer/client/components/ohifViewer/ohifViewer.html#L2) \ No newline at end of file + {% endraw %} + + For example, see how it works in [OHIF Viewer](https://github.com/OHIF/Viewers/blob/master/OHIFViewer/client/components/ohifViewer/ohifViewer.html#L2) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 81806a78c..2dcf5bcee 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -27,7 +27,7 @@ - [Security](deployment/security.md) - I Want To... - [Add a Tool to the Viewer](I-want-to/add-a-tool-to-the-viewer.md) - - [Add Logo to the Viewer](I-want-to/add-logo-to-the-viewer.md) + - [Add a Logo to the Viewer](I-want-to/add-a-logo-to-the-viewer.md) ---- - Example Applications diff --git a/docs/book.json b/docs/book.json index 7b4110611..084331971 100644 --- a/docs/book.json +++ b/docs/book.json @@ -1,11 +1,15 @@ { "title": "OHIF", + "description": "Documentation for the OHIF framework", "gitbook": ">3.0.0", "plugins": [ "edit-link", "theme-cornerstone", "-fontsettings", - "github" + "github", + "ga", + "sitemap", + "anchors" ], "pluginsConfig": { "edit-link": { @@ -14,6 +18,12 @@ }, "github": { "url": "https://github.com/OHIF/Viewers" + }, + "ga": { + "token": "UA-110573590-2" + }, + "sitemap": { + "hostname": "https://docs.ohif.org" } }, "links": { diff --git a/docs/package.json b/docs/package.json index 0a0b07291..ed23bd515 100644 --- a/docs/package.json +++ b/docs/package.json @@ -33,6 +33,8 @@ "homepage": "https://github.com/OHIF/Viewers#readme", "dependencies": { "gitbook-plugin-edit-link": "^2.0.2", - "gitbook-plugin-github": "^3.0.0" + "gitbook-plugin-github": "^3.0.0", + "gitbook-plugin-ga": "^2.0.0", + "gitbook-plugin-sitemap": "^1.2.0" } }