diff --git a/tools/jsdoc/config.json b/tools/jsdoc/config.json index 5074362225..36f827338c 100644 --- a/tools/jsdoc/config.json +++ b/tools/jsdoc/config.json @@ -2,16 +2,19 @@ "opts": { "template": "hifi-jsdoc-template" }, + "deploy": { + "root": "https://apidocs.vircadia.dev/" + }, "docdash": { - "meta": { - "title": "", - "description": "", - "keyword": "" + "meta": { + "title": "Vircadia API Docs", + "description": "API documentation for Vircadia.", + "keyword": "api, docs, vircadia, documentation" }, - "search": [true], - "collapse": [true], - "typedefs": [false] - }, + "search": [true], + "collapse": [true], + "typedefs": [false] + }, "templates": { "default": { "outputSourceFiles": false diff --git a/tools/jsdoc/hifi-jsdoc-template/publish.js b/tools/jsdoc/hifi-jsdoc-template/publish.js index 4ca4eb469e..80b985c8a1 100644 --- a/tools/jsdoc/hifi-jsdoc-template/publish.js +++ b/tools/jsdoc/hifi-jsdoc-template/publish.js @@ -380,8 +380,8 @@ function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { itemsNav += ""; } - - + + itemsNav += ''; itemsSeen[item.longname] = true; } diff --git a/tools/jsdoc/hifi-jsdoc-template/static/CNAME b/tools/jsdoc/hifi-jsdoc-template/static/CNAME new file mode 100644 index 0000000000..540222fee1 --- /dev/null +++ b/tools/jsdoc/hifi-jsdoc-template/static/CNAME @@ -0,0 +1 @@ +apidocs.vircadia.dev \ No newline at end of file diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl index 1ecd7fc7e0..49ab106347 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/layout.tmpl @@ -3,7 +3,7 @@ - <?js= title ?> + <?js= title ?> - Vircadia API Docs @@ -13,6 +13,7 @@ + ' ?> @@ -42,7 +43,7 @@ } catch (e) { // nop } - + var defaultDarkDisabled = false; var darkDisabled = isLocalStorageSupported ? JSON.parse(localStorage.getItem('darkDisabled')) : defaultDarkDisabled; var nightSheet = document.querySelector('[href="styles/night.css"]'); @@ -53,7 +54,7 @@ } var defaultResponsiveDisabled = true; - var responsiveDisabled = + var responsiveDisabled = isLocalStorageSupported ? JSON.parse(localStorage.getItem('responsiveDisabled')) : defaultResponsiveDisabled; var responsiveSheet = document.querySelector('[href="styles/responsive.css"]'); if (responsiveDisabled === null) { @@ -78,7 +79,7 @@ -

Looking for Vircadia
Documentation?

+

Looking for Vircadia
Documentation?

Toggle mdi-theme-light-dark @@ -95,7 +96,7 @@

- +