@healthcatalyst/catalyst-docfx-template 1.0.56 → 1.0.59

package/README.md

@@ -1,54 +1,50 @@
-# docfx-tmpl
-A DocFX Template patching the Default template.
-
-Supported DocFX version: [v2.17.4](https://github.com/dotnet/docfx/releases/tag/v2.17.4)
-
-## Changes from Default Template
-- Full Width (uses container-fluid instead of container).
-- Affix sidebar styled like Bootstrap Documentation.
-- Thinner TOC toggle button on mobiles.
-- Hides the **IN THIS ARTICLE** heading above sidebar.
-- Tabular views for Namespace.
-- Pretty tables for Class view.
-- Collapsible sections in API documentation.
-- Round Buttons for View-Source and Edit.
-- Different colors.
-
-## How to use
-The template is contained in the source folder.
-
-**Clone or Download**  
-In a terminal, run: `git clone https://github.com/MathewSachin/docfx-tmpl.git`
-
-**Apply Template**  
-Use `default, <relative path to src folder of this template>`
-
-In docfx.json (showing only relevant portion):
-
-```json
-{
-    "build": {
-        "template": [
-            "default",
-            "docfx-tmpl/src"
-        ]
-    }
-}
+# catalyst-docfx-template
+
+## Prerequisites
+
+- [NodeJs](https://nodejs.org/en/download/)
+- [DocFX](https://dotnet.github.io/docfx/tutorial/docfx_getting_started.html)
+- [Angular 10+ cli](https://angular.io/cli)
+  
+```sh
+npm install -g @angular/cli
 ```
 
-**OR**
+- [Gulp](https://gulpjs.com/docs/en/getting-started/quick-start/)
+  
+```sh
+npm install --global gulp-cli
+```
 
-In Command-line:
+## Build Navbar angular universal element
 
+**Do this before publishing or development!!**
+
+```sh
+cd src/homepage/ClientApp
+npm install
+npm run build:docs-navbar
 ```
-docfx -t default,docfx-tmpl/src
+
+An Angular js file will be published to `homepage/ClientApp/src/assets/docs-navbar.js` and  `catalyst-docfx-template/templates/catalyst/styles/docs-navbar.js`
+
+## Publishing
+
+Publish the docfx site
+
+```sh
+cd src/catalyst-docfx-template
+docfx build
 ```
 
-## ScreenShots
-![Large](screenshots/1.png)
+All website artifacts are in the `_site`
 
-![Small](screenshots/2.png)
+## Development
+
+```sh
+cd src/catalyst-docfx-template
+gulp start
+```
 
-![XS](screenshots/3.png)
+Your browser should automatically open <http://localhost:3000/>
 
-![Navbar](screenshots/4.png)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@healthcatalyst/catalyst-docfx-template",
-  "version": "1.0.56",
+  "version": "1.0.59",
   "license": "MIT",
   "description": "A DocFX Template patching the Default template.",
   "publishConfig": {

package/styles/main.css

@@ -1641,4 +1641,132 @@ a.anchor {
 pre {
     /* Avoid pushing up the copy buttons. */
     /* margin: 0; */
+}
+
+/* This code hides cross references between PDF pages. Corresponding code (.web-only) that hides cross references in the web app is in /templates/pdf/styles/main.css. */
+.pdf-only {
+    display: none;
+}
+
+/*
+  .sidetoc, .sidefilter {
+    margin-top: 56px;
+  }
+  */
+
+.statusMessage {
+    background-color: #aae2c8;
+    font-size: 13.5px;
+    font-weight: 600;
+    padding-top: 15px;
+    padding-bottom: 20px;
+    padding-right: 15px;
+    margin-top: -16px;
+    margin-right: 16px;
+    margin-left: -40px;
+    margin-bottom: 10px;
+    padding-left: 5em;
+    text-indent: -5em;
+}
+
+#statusIcon {
+    font-size: 24px;
+    margin-left: 100px;
+    transform: translate(0, 5px);
+    margin-right: -36px;
+}
+
+.toc-deprecated:before {
+    content: 'Deprecated' !important;
+    background-color: #d7dde4;
+    color: #333;
+    border-radius: 3px;
+    font-size: 9px;
+    text-transform: uppercase;
+    font-weight: 600;
+    letter-spacing: 0.15px;
+    margin-left: 0px;
+    margin-top: 4px;
+    margin-bottom: 4px;
+    margin-right: 4px;
+    padding: 3px 7px 3px 10px;
+    position: relative;
+    top: -1px;
+}
+
+/* "Page has moved/is obsolete" banner at top of page */
+
+#nextWarning {
+    background-color: #ffdbb7;
+    font-size: 12px;
+    font-weight: 400;
+    height: 35px;
+}
+
+#nextWarning p {
+    text-align: center;
+    margin: auto;
+    font-size: 13.5px;
+    font-weight: 600;
+}
+
+#nextWarningToc {
+    margin-top: 56px;
+}
+
+/* Which DOS versions apply to page */
+
+#tag {
+    font-size: 13.5px;
+    font-weight: 600;
+    padding-top: 15px;
+    padding-bottom: 15px;
+    padding-right: 15px;
+    padding-left: 15px;
+    margin-top: -16px !important;
+    margin-left: -50px;
+    margin-bottom: 10px !important;
+    margin-right: 15px;
+    text-indent: 4em;
+    background: #d6f3ff;
+}
+
+#dosVersion {
+    padding-left: 12px;
+    font-weight: 400;
+}
+
+#success-checkmark {
+    background: #00aeff;
+    color: white;
+    padding: 1px 4px;
+    border-radius: 50%;
+    padding-right: 1px;
+    margin-right: 8px;
+}
+
+#version-bump {
+    padding-right: 15px;
+}
+
+/* Styles a message in a line anywhere in the document with {{ term }} - see main.js */
+
+.message {
+    font-size: 13.5px;
+    font-weight: 600;
+    padding-top: 8px;
+    padding-bottom: 8px;
+    padding-left: 15px;
+    margin-top: 35px;
+    margin-bottom: -5px;
+    text-indent: 2em;
+    background: #d6f3ff;
+    display: inline-block;
+    width: 100%;
+}
+
+.message > .fa:before {
+    margin-left: -52px;
+    padding-right: 10px;
+    color: #00aeff;
 }

package/styles/main.js

@@ -139,7 +139,7 @@ copyCode.on('success', function(event) {
 var terms = (function () {
     var json = null;
     var baseUrl = window.location.origin;
-    console.log(baseUrl);
+    // console.log(baseUrl);
     $.ajax({
       async: false,
       global: false,
@@ -151,7 +151,7 @@ var terms = (function () {
     });
 
     for (let [key, value] of Object.entries(json)) {
-       console.log(`${key}: ${value}`);
+      // console.log(`${key}: ${value}`);
       var toReplace = "{{ " + key + " }}";
       var replaceWith = value;
       document.body.innerHTML = document.body.innerHTML.replace(
@@ -167,7 +167,7 @@ var terms = (function () {
   var messages = (function () {
     var json = null;
     var baseUrl = window.location.origin;
-    console.log(baseUrl)
+    // console.log(baseUrl)
     $.ajax({
       async: false,
       global: false,