diff --git a/.github/workflows/api-docs.yml b/.github/workflows/api-docs.yml
index 1c9c51cee..c3b3cc417 100644
--- a/.github/workflows/api-docs.yml
+++ b/.github/workflows/api-docs.yml
@@ -26,14 +26,15 @@ jobs:
dotnet-version: 7.0
dotnet-quality: 'ga'
- - name: Setup DocFX
- uses: crazy-max/ghaction-chocolatey@v2
- with:
- args: install docfx
+ # - name: Setup DocFX
+ # uses: crazy-max/ghaction-chocolatey@v2
+ # with:
+ # args: install docfx
- name: DocFX Build
working-directory: docfx
run: |
+ dotnet tool install -g docfx
rm ../docs -Recurse -Force -ErrorAction SilentlyContinue
rm ../api -Recurse -Force -ErrorAction SilentlyContinue
$env:DOCFX_SOURCE_BRANCH_NAME="${{ github.ref_name }}"
diff --git a/Terminal.sln b/Terminal.sln
index 58a9ace1a..4d1712f8e 100644
--- a/Terminal.sln
+++ b/Terminal.sln
@@ -15,6 +15,7 @@ EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{E143FB1F-0B88-48CB-9086-72CDCECFCD22}"
ProjectSection(SolutionItems) = preProject
.gitignore = .gitignore
+ .github\workflows\api-docs.yml = .github\workflows\api-docs.yml
.github\CODEOWNERS = .github\CODEOWNERS
CODE_OF_CONDUCT.md = CODE_OF_CONDUCT.md
CONTRIBUTING.md = CONTRIBUTING.md
diff --git a/docfx/build.ps1 b/docfx/build.ps1
index b40d968ee..a4a22f548 100644
--- a/docfx/build.ps1
+++ b/docfx/build.ps1
@@ -5,6 +5,8 @@ $prevPwd = $PWD; Set-Location -ErrorAction Stop -LiteralPath $PSScriptRoot
try {
$PWD # output the current location
+ dotnet tool update -g docfx
+
dotnet build --configuration Release ../Terminal.sln
rm ../docs -Recurse -Force -ErrorAction SilentlyContinue
diff --git a/docfx/docfx.json b/docfx/docfx.json
index bccdb04f7..ac15efdd1 100644
--- a/docfx/docfx.json
+++ b/docfx/docfx.json
@@ -91,7 +91,7 @@
"globalMetadata": {
"_appTitle": "Terminal.Gui v2",
"_appName": "Terminal.Gui v2",
- "_appFaviconPath": "images/favicon.png",
+ "_appFaviconPath": "images/icon48.png",
"_appLogoPath": "images/logo.png",
"_appFooter": "Terminal.Gui - Part of the gui-cs Organization",
"_enableSearch": true,
@@ -108,6 +108,7 @@
},
"_gitUrlPattern": "github"
},
+ "markdownEngineName": "markdig",
"globalMetadataFiles": [],
"fileMetadataFiles": [],
"postProcessors": ["ExtractSearchIndex"],
diff --git a/docfx/plugins/memberpage-extras/ManagedReference.extension.js b/docfx/plugins/memberpage-extras/ManagedReference.extension.js
new file mode 100644
index 000000000..2e43f43fd
--- /dev/null
+++ b/docfx/plugins/memberpage-extras/ManagedReference.extension.js
@@ -0,0 +1,33 @@
+// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
+var common = require('./ManagedReference.common.js');
+
+exports.preTransform = function (model) {
+ transform(model);
+
+ function transform(item) {
+ if (item.children) item.children.forEach(function(i) {
+ transform(i);
+ });
+ }
+
+ return model;
+}
+
+exports.postTransform = function (model) {
+ var type = model.type.toLowerCase();
+ var category = common.getCategory(type);
+ if (category == 'class') {
+ var typePropertyName = common.getTypePropertyName(type);
+ if (typePropertyName) {
+ model[typePropertyName] = true;
+ }
+ if (model.children && model.children.length > 0) {
+ model.isCollection = true;
+ common.groupChildren(model, 'class');
+ } else {
+ model.isItem = true;
+ }
+ }
+
+ return model;
+}
\ No newline at end of file
diff --git a/docfx/plugins/memberpage-extras/toc.html.js b/docfx/plugins/memberpage-extras/toc.html.js
new file mode 100644
index 000000000..a24a5b260
--- /dev/null
+++ b/docfx/plugins/memberpage-extras/toc.html.js
@@ -0,0 +1,79 @@
+// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
+exports.transform = function (model) {
+ var groupNames = {
+ "constructor": { key: "constructorsInSubtitle" },
+ "field": { key: "fieldsInSubtitle" },
+ "property": { key: "propertiesInSubtitle" },
+ "method": { key: "methodsInSubtitle" },
+ "event": { key: "eventsInSubtitle" },
+ "operator": { key: "operatorsInSubtitle" },
+ "eii": { key: "eiisInSubtitle" },
+ };
+
+ groupChildren(model);
+ transformItem(model, 1);
+ return model;
+
+ function groupChildren(item) {
+ if (!item || !item.items || item.items.length == 0) {
+ return;
+ }
+ var grouped = {};
+ var items = [];
+ item.items.forEach(function (element) {
+ groupChildren(element);
+ if (element.type) {
+ var type = element.isEii ? "eii" : element.type.toLowerCase();
+ if (!grouped.hasOwnProperty(type)) {
+ if (!groupNames.hasOwnProperty(type)) {
+ groupNames[type] = {
+ name: element.type
+ };
+ console.log(type + " is not predefined type, use its type name as display name.")
+ }
+ grouped[type] = [];
+ }
+ grouped[type].push(element);
+ } else {
+ items.push(element);
+ }
+ }, this);
+
+ // With order defined in groupNames
+ for (var key in groupNames) {
+ if (groupNames.hasOwnProperty(key) && grouped.hasOwnProperty(key)) {
+ items.push({
+ name: model.__global[groupNames[key].key] || groupNames[key].name,
+ items: grouped[key]
+ })
+ }
+ }
+
+ item.items = items;
+ }
+
+ function transformItem(item, level) {
+ // set to null in case mustache looks up
+ item.topicHref = item.topicHref || null;
+ item.tocHref = item.tocHref || null;
+ item.name = item.name || null;
+
+ item.level = level;
+
+ // Add word break opportunities before dots
+
+ if (item.name)
+ item.name = item.name.replace(/\./g, "\u200B.");
+
+ if (item.items && item.items.length > 0) {
+ item.leaf = false;
+ var length = item.items.length;
+ for (var i = 0; i < length; i++) {
+ transformItem(item.items[i], level + 1);
+ };
+ } else {
+ item.items = [];
+ item.leaf = true;
+ }
+ }
+}
\ No newline at end of file
diff --git a/docfx/plugins/memberpage.2.59.4/ManagedReference.extension.js b/docfx/plugins/memberpage.2.59.4/ManagedReference.extension.js
new file mode 100644
index 000000000..770c2938e
--- /dev/null
+++ b/docfx/plugins/memberpage.2.59.4/ManagedReference.extension.js
@@ -0,0 +1,20 @@
+// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
+var common = require('./ManagedReference.common.js');
+
+exports.postTransform = function (model) {
+ var type = model.type.toLowerCase();
+ var category = common.getCategory(type);
+ if (category == 'class') {
+ var typePropertyName = common.getTypePropertyName(type);
+ if (typePropertyName) {
+ model[typePropertyName] = true;
+ }
+ if (model.children && model.children.length > 0) {
+ model.isCollection = true;
+ common.groupChildren(model, 'class');
+ } else {
+ model.isItem = true;
+ }
+ }
+ return model;
+}
\ No newline at end of file
diff --git a/docfx/plugins/memberpage.2.59.4/ManagedReference.overwrite.js b/docfx/plugins/memberpage.2.59.4/ManagedReference.overwrite.js
new file mode 100644
index 000000000..9e6f29e88
--- /dev/null
+++ b/docfx/plugins/memberpage.2.59.4/ManagedReference.overwrite.js
@@ -0,0 +1,10 @@
+// Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.
+var common = require('./ManagedReference.common.js');
+
+exports.getOptions = function (model) {
+ var ignoreChildrenBookmarks = model._splitReference && model.type && common.getCategory(model.type) === 'ns';
+
+ return {
+ "bookmarks": common.getBookmarks(model, ignoreChildrenBookmarks)
+ };
+}
\ No newline at end of file
diff --git a/docfx/plugins/memberpage.2.59.4/partials/class.tmpl.partial b/docfx/plugins/memberpage.2.59.4/partials/class.tmpl.partial
new file mode 100644
index 000000000..e52fa611d
--- /dev/null
+++ b/docfx/plugins/memberpage.2.59.4/partials/class.tmpl.partial
@@ -0,0 +1,59 @@
+{{!Copyright (c) Microsoft. All rights reserved. Licensed under the MIT license. See LICENSE file in the project root for full license information.}}
+
+{{>partials/class.header}}
+{{#children}}
+{{#overload}}
+
+{{/overload}}
+{{>partials/classSubtitle}}
+{{#children.0}}
+
+
+
+ | {{__global.name}} |
+ {{__global.description}} |
+
+
+
+ {{/children.0}}
+ {{#children}}
+
+ |
+
+ |
+ {{{summary}}} |
+
+ {{/children}}
+ {{#children.0}}
+
+
+{{/children.0}}
+{{/children}}
+{{#extensionMethods.0}}
+{{__global.extensionMethods}}
+{{/extensionMethods.0}}
+{{#extensionMethods}}
+
+ {{#definition}}
+
+ {{/definition}}
+ {{^definition}}
+
+ {{/definition}}
+
+{{/extensionMethods}}
+{{#seealso.0}}
+{{__global.seealso}}
+
+{{/seealso.0}}
+{{#seealso}}
+ {{#isCref}}
+
{{{type.specName.0.value}}}
+ {{/isCref}}
+ {{^isCref}}
+
{{{url}}}
+ {{/isCref}}
+{{/seealso}}
+{{#seealso.0}}
+
{{>partials/title}}
+{{{summary}}}
+{{{conceptual}}}
+
+{{#children}}
+{{#children}}
+{{^_disableContribution}}
+{{#docurl}}
+
+ |
+ {{__global.improveThisDoc}}
+{{/docurl}}
+{{#sourceurl}}
+
+ {{__global.viewSource}}
+{{/sourceurl}}
+{{/_disableContribution}}
+{{#overload}}
+
+{{/overload}}
+{{name.0.value}}
+{{{summary}}}
+{{{conceptual}}}
+{{__global.declaration}}
+{{#syntax}}
+
+
{{syntax.content.0.value}}
+
{{__global.parameters}}
+
+
+
+ | {{__global.type}} |
+ {{__global.name}} |
+ {{__global.description}} |
+
+
+
+{{/parameters.0}}
+{{#parameters}}
+
+ | {{{type.specName.0.value}}} |
+ {{{id}}} |
+ {{{description}}} |
+
+{{/parameters}}
+{{#parameters.0}}
+
+
+{{/parameters.0}}
+{{#return}}
+{{__global.returns}}
+
+
+
+ | {{__global.type}} |
+ {{__global.description}} |
+
+
+
+
+ | {{{type.specName.0.value}}} |
+ {{{description}}} |
+
+
+
+{{/return}}
+{{#typeParameters.0}}
+{{__global.typeParameters}}
+
+
+
+ | {{__global.name}} |
+ {{__global.description}} |
+
+
+
+{{/typeParameters.0}}
+{{#typeParameters}}
+
+ | {{{id}}} |
+ {{{description}}} |
+
+{{/typeParameters}}
+{{#typeParameters.0}}
+
+
+{{/typeParameters.0}}
+{{#fieldValue}}
+{{__global.fieldValue}}
+
+
+
+ | {{__global.type}} |
+ {{__global.description}} |
+
+
+
+
+ | {{{type.specName.0.value}}} |
+ {{{description}}} |
+
+
+
+{{/fieldValue}}
+{{#propertyValue}}
+{{__global.propertyValue}}
+
+
+
+ | {{__global.type}} |
+ {{__global.description}} |
+
+
+
+
+ | {{{type.specName.0.value}}} |
+ {{{description}}} |
+
+
+
+{{/propertyValue}}
+{{#eventType}}
+{{__global.eventType}}
+
+
+
+ | {{__global.type}} |
+ {{__global.description}} |
+
+
+
+
+ | {{{type.specName.0.value}}} |
+ {{{description}}} |
+
+
+
+{{/eventType}}
+{{/syntax}}
+{{#overridden}}
+{{__global.overrides}}
+
+{{/overridden}}
+{{#implements.0}}
+{{__global.implements}}
+{{/implements.0}}
+{{#implements}}
+ {{#definition}}
+
+ {{/definition}}
+ {{^definition}}
+
+ {{/definition}}
+{{/implements}}
+{{#remarks}}
+
+
+{{/remarks}}
+{{#example.0}}
+{{__global.examples}}
+{{/example.0}}
+{{#example}}
+{{{.}}}
+{{/example}}
+{{#exceptions.0}}
+{{__global.exceptions}}
+
+
+
+ | {{__global.type}} |
+ {{__global.condition}} |
+
+
+
+{{/exceptions.0}}
+{{#exceptions}}
+
+ | {{{type.specName.0.value}}} |
+ {{{description}}} |
+
+{{/exceptions}}
+{{#exceptions.0}}
+
+
+{{/exceptions.0}}
+{{#seealso.0}}
+{{__global.seealso}}
+
+{{/seealso.0}}
+{{#seealso}}
+ {{#isCref}}
+
{{{type.specName.0.value}}}
+ {{/isCref}}
+ {{^isCref}}
+
{{{url}}}
+ {{/isCref}}
+{{/seealso}}
+{{#seealso.0}}
+
{{__global.extensionMethods}}
+{{/extensionMethods.0}}
+{{#extensionMethods}}
+
+ {{#definition}}
+
+ {{/definition}}
+ {{^definition}}
+
+ {{/definition}}
+
+{{/extensionMethods}}
+{{#seealso.0}}
+{{__global.seealso}}
+
+{{/seealso.0}}
+{{#seealso}}
+ {{#isCref}}
+
{{{type.specName.0.value}}}
+ {{/isCref}}
+ {{^isCref}}
+
{{{url}}}
+ {{/isCref}}
+{{/seealso}}
+{{#seealso.0}}
+