diff --git a/docfx/docfx_project/artemis-template/public/main.css b/docfx/docfx_project/artemis-template/public/main.css new file mode 100644 index 000000000..625bcc189 --- /dev/null +++ b/docfx/docfx_project/artemis-template/public/main.css @@ -0,0 +1,4 @@ +#logo { + height: 40px; + margin-right: 10px; +} \ No newline at end of file diff --git a/docfx/docfx_project/docfx.json b/docfx/docfx_project/docfx.json index 7b5a81816..e1d18f44b 100644 --- a/docfx/docfx_project/docfx.json +++ b/docfx/docfx_project/docfx.json @@ -11,7 +11,8 @@ } ], "dest": "api", - "filter": "filterConfig.yml" + "filter": "filterConfig.yml", + "namespaceLayout": "nested" } ], "build": { @@ -35,11 +36,14 @@ "output": "_site", "template": [ "default", - "modern" + "modern", + "artemis-template" ], "globalMetadata": { "_appTitle": "Artemis API Documentation", "_appName": "Artemis", + "_appLogoPath": "images/application.ico", + "_appFaviconPath": "images/application.ico", "_copyrightFooter": "Content is available under the PolyForm Noncommercial License, by Artemis RGB.", "_enableSearch": true, "_disableSideFilter": false, diff --git a/docfx/docfx_project/filterConfig.yml b/docfx/docfx_project/filterConfig.yml index d56cc1bd4..a8c6eb018 100644 --- a/docfx/docfx_project/filterConfig.yml +++ b/docfx/docfx_project/filterConfig.yml @@ -24,5 +24,5 @@ apiRules: uidRegex: ^Artemis\.UI\.Shared\.Properties type: Type - exclude: - uidRegex: ^Artemis\.Core\.TypeExtensions\.IsNumber - type: Method \ No newline at end of file + uidRegex: ^Artemis\.Core\.TypeExtensions + type: Type \ No newline at end of file diff --git a/docfx/docfx_project/index.md b/docfx/docfx_project/index.md index f9859f840..641c4d1a6 100644 --- a/docfx/docfx_project/index.md +++ b/docfx/docfx_project/index.md @@ -2,10 +2,6 @@ _layout: landing --- -# This is the **HOMEPAGE**. - -Refer to [Markdown](http://daringfireball.net/projects/markdown/) for how to write markdown files. - -## Quick Start Notes: - -1. Add images to the *images* folder if the file is referencing an image. \ No newline at end of file +# Artemis Technical Documentation +Welcome to the technical docs of Artemis. This page contains all the public types available when writing Artemis plugins. +For more details, please refer to the [Artemis wiki](https://wiki.artemis-rgb.com/en/guides/developer). \ No newline at end of file diff --git a/docfx/docfx_project/toc.yml b/docfx/docfx_project/toc.yml index 061acc65f..aba634266 100644 --- a/docfx/docfx_project/toc.yml +++ b/docfx/docfx_project/toc.yml @@ -1,4 +1,2 @@ -- name: Docs - href: docs/ -- name: API +- name: Plugin API href: api/ \ No newline at end of file diff --git a/docfx/docfx_project/docs/getting-started.md b/docfx/docs/getting-started.md similarity index 100% rename from docfx/docfx_project/docs/getting-started.md rename to docfx/docs/getting-started.md diff --git a/docfx/docfx_project/docs/introduction.md b/docfx/docs/introduction.md similarity index 100% rename from docfx/docfx_project/docs/introduction.md rename to docfx/docs/introduction.md diff --git a/docfx/docfx_project/docs/toc.yml b/docfx/docs/toc.yml similarity index 100% rename from docfx/docfx_project/docs/toc.yml rename to docfx/docs/toc.yml