@healthcatalyst/catalyst-docfx-template 1.0.55 → 1.0.58

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/layout/_master.tmpl

@@ -36,8 +36,8 @@
         {{>partials/statusMessage}}
         {{/_disableStatusMessage}}
         {{/if}}
-        {{#if version}}
-        {{>partials/version}}
+        {{#if dosVersion}}
+        {{>partials/dosVersion}}
         {{/if}}
         {{#if wide}}
           <div class="col-sm-12">

package/package.json

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

package/partials/{sql-server.tmpl.partial → dosClassic.tmpl.partial}

@@ -2,5 +2,5 @@
 ✔
 </span>
 <span id="version-bump">
-DOS for SQL Server
+DOS Classic
 </span>

package/partials/{snowflake.tmpl.partial → dosCloud.tmpl.partial}

@@ -2,5 +2,5 @@
 ✔
 </span>
 <span id="version-bump">
-DOS for Snowflake
+DOS Cloud
 </span>

package/partials/dosVersion.tmpl.partial

@@ -0,0 +1,7 @@
+<div id="tag">
+  Applies to:
+  <span id="dosVersion">
+  {{#if dosVersion.dosCloud}}{{>partials/dosCloud}}{{/if}}
+  {{#if dosVersion.dosClassic}}{{>partials/dosClassic}}{{/if}}
+  </span>
+</div>

package/styles/main.css

@@ -1731,7 +1731,7 @@ pre {
     background: #d6f3ff;
 }
 
-#version {
+#dosVersion {
     padding-left: 12px;
     font-weight: 400;
 }

package/styles/main.js

@@ -139,11 +139,11 @@ 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,
-      url: baseUrl + "/sourcedContent/terms.json",
+      url: baseUrl + "sourcedContent/terms.json",
       dataType: "json",
       success: function (data) {
         json = data;
@@ -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,11 +167,11 @@ 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,
-      url: baseUrl + "/sourcedContent/messages.json",
+      url: baseUrl + "sourcedContent/messages.json",
       dataType: "json",
       success: function (data) {
         json = data;

package/partials/version.tmpl.partial

@@ -1,7 +0,0 @@
-<div id="tag">
-  Applies to:
-  <span id="version">
-  {{#if version.snowflake}}{{>partials/snowflake}}{{/if}}
-  {{#if version.sql-server}}{{>partials/sql-server}}{{/if}}
-  </span>
-</div>