From ce1fd015ae2662457e56eddb77033f00fd3c39f2 Mon Sep 17 00:00:00 2001 From: wagesj45 Date: Tue, 7 Jul 2026 23:25:22 -0500 Subject: [PATCH] Use DocFX Material for docs --- Docs/docfx.json | 31 +-- Docs/material/LICENSE | 21 ++ Docs/material/material/public/main.css | 182 +++++++++++++++ Docs/templates/discordfx/layout/_master.tmpl | 52 ----- .../partials/class.header.tmpl.partial | 104 --------- .../partials/class.memberpage.tmpl.partial | 46 ---- .../discordfx/partials/class.tmpl.partial | 221 ------------------ Docs/templates/discordfx/styles/main.css | 21 -- Docs/toc.yml | 2 +- 9 files changed, 213 insertions(+), 467 deletions(-) create mode 100644 Docs/material/LICENSE create mode 100644 Docs/material/material/public/main.css delete mode 100644 Docs/templates/discordfx/layout/_master.tmpl delete mode 100755 Docs/templates/discordfx/partials/class.header.tmpl.partial delete mode 100755 Docs/templates/discordfx/partials/class.memberpage.tmpl.partial delete mode 100755 Docs/templates/discordfx/partials/class.tmpl.partial delete mode 100644 Docs/templates/discordfx/styles/main.css diff --git a/Docs/docfx.json b/Docs/docfx.json index e4ad8f0..2711df0 100644 --- a/Docs/docfx.json +++ b/Docs/docfx.json @@ -4,48 +4,35 @@ { "src": [ { - "src": ".././", + "src": "../CapyKit", "files": [ - "**/*.csproj" + "CapyKit.csproj" ] } ], - "dest": "api", - "properties": { - "TargetFramework": "net8.0" - } + "dest": "api" } ], "build": { "content": [ { "files": [ - "toc.yml", - "index.md", - "introduction.md", - "getting-started.md", - "api/*.yml", - "api/toc.yml" + "**/*.{md,yml}" ], "exclude": [ - "_site/**" - ] - } - ], - "resource": [ - { - "files": [ - "images/**" + "_site/**", + "material/**" ] } ], "output": "_site", "template": [ "default", - "templates/discordfx" + "modern", + "material/material" ], "globalMetadata": { - "_appName": "CapyKit Documentation", + "_appName": "CapyKit", "_appTitle": "CapyKit Documentation", "_enableSearch": true, "pdf": false diff --git a/Docs/material/LICENSE b/Docs/material/LICENSE new file mode 100644 index 0000000..4576c42 --- /dev/null +++ b/Docs/material/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2019 Oscar Vásquez + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/Docs/material/material/public/main.css b/Docs/material/material/public/main.css new file mode 100644 index 0000000..06fd6a7 --- /dev/null +++ b/Docs/material/material/public/main.css @@ -0,0 +1,182 @@ +@import url('https://fonts.googleapis.com/css2?family=Roboto:wght@100;400;700&display=swap'); + +:root { + --bs-font-sans-serif: 'Roboto'; + --bs-border-radius: 10px; + + --border-radius-button: 40px; + --card-box-shadow: 0 1px 2px 0 #3d41440f, 0 1px 3px 1px #3d414429; + + --material-yellow-light: #e6dfbf; + --material-yellow-dark: #5a5338; + + --material-blue-light: #c4d9f1; + --material-blue-dark: #383e5a; + + --material-red-light: #f1c4c4; + --material-red-dark: #5a3838; + + --material-warning-header: #f57f171a; + --material-warning-background: #f6e8bd; + --material-warning-background-dark: #57502c; + + --material-info-header: #1976d21a; + --material-info-background: #e3f2fd; + --material-info-background-dark: #2c4557; + + --material-danger-header: #d32f2f1a; + --material-danger-background: #ffebee; + --material-danger-background-dark: #572c2c; +} + +/* HEADINGS */ + +h1 { + font-weight: 600; + font-size: 32px; +} + +h2 { + font-weight: 600; + font-size: 24px; + line-height: 1.8; +} + +h3 { + font-weight: 600; + font-size: 20px; + line-height: 1.8; +} + +h5 { + font-size: 14px; + padding: 10px 0px; +} + +article h2, +article h3, +article h4 { + margin-top: 15px; + margin-bottom: 15px; +} + +article h4 { + padding-bottom: 8px; + border-bottom: 2px solid #ddd; +} + +/** IMAGES **/ +img { + border-radius: var(--bs-border-radius); + box-shadow: var(--card-box-shadow); +} + +/** NAVBAR **/ +.navbar-brand > img { + box-shadow: none; + color: var(--bs-nav-link-color); +} + +[data-bs-theme='light'] nav.navbar { + background-color: var(--bs-primary-bg-subtle); +} + +[data-bs-theme='dark'] nav.navbar { + background-color: var(--bs-tertiary-bg); +} + +.navbar-nav > li > a { + border-radius: var(--border-radius-button); + transition: 200ms; +} + +.navbar-nav a.nav-link:focus, +.navbar-nav a.nav-link:hover { + background-color: var(--bs-primary-border-subtle); +} + +.navbar-nav .nav-link.active, +.navbar-nav .nav-link.show { + color: var(--bs-link-hover-color); +} + +/** SEARCH AND FILTER **/ +input.form-control { + border-radius: var(--border-radius-button); +} + +form.filter { + margin: 0.3rem; +} + +/** ALERTS **/ +.alert { + padding: 0; + border: none; + box-shadow: var(--card-box-shadow); +} + +.alert > p { + padding: 0.2rem 0.7rem 0.7rem 1rem; +} + +.alert > ul { + margin-bottom: 0; + padding: 5px 40px; +} + +.alert > h5 { + padding: 0.5rem 0.7rem 0.7rem 1rem; + border-radius: var(--bs-border-radius) var(--bs-border-radius) 0 0; + font-weight: bold; + text-transform: capitalize; +} + +.alert-info { + color: var(--material-blue-dark); + background-color: var(--material-info-background); +} + +[data-bs-theme='dark'] .alert-info { + color: var(--material-blue-light); + background-color: var(--material-info-background-dark); +} + +.alert-info > h5 { + background-color: var(--material-info-header); +} + +.alert-warning { + color: var(--material-yellow-dark); + background-color: var(--material-warning-background); +} + +[data-bs-theme='dark'] .alert-warning { + color: var(--material-yellow-light); + background-color: var(--material-warning-background-dark); +} + +.alert-warning > h5 { + background-color: var(--material-warning-header); +} + +.alert-danger { + color: var(--material-red-dark); + background-color: var(--material-danger-background); +} + +[data-bs-theme='dark'] .alert-danger { + color: var(--material-red-light); + background-color: var(--material-danger-background-dark); +} + +.alert-danger > h5 { + background-color: var(--material-danger-header); +} + +/* CODE HIGHLIGHT */ +code { + border-radius: var(--bs-border-radius); + margin: 4px 2px; + box-shadow: var(--card-box-shadow); +} diff --git a/Docs/templates/discordfx/layout/_master.tmpl b/Docs/templates/discordfx/layout/_master.tmpl deleted file mode 100644 index c8cbf7b..0000000 --- a/Docs/templates/discordfx/layout/_master.tmpl +++ /dev/null @@ -1,52 +0,0 @@ -{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} -{{!include(/^styles/.*/)}} -{{!include(/^fonts/.*/)}} -{{!include(favicon.ico)}} -{{!include(logo.svg)}} -{{!include(search-stopwords.json)}} - - - - {{>partials/head}} - {{^redirect_url}} - -
-
- {{^_disableNavbar}} - {{>partials/navbar}} - {{/_disableNavbar}} - {{^_disableBreadcrumb}} - {{>partials/breadcrumb}} - {{/_disableBreadcrumb}} -
- {{#_enableSearch}} -
- {{>partials/searchResults}} -
- {{/_enableSearch}} -
- {{>partials/toc}} -
- {{#_disableAffix}} -
- {{/_disableAffix}} - {{^_disableAffix}} -
- {{/_disableAffix}} -
- {{!body}} -
-
- {{^_disableAffix}} - {{>partials/affix}} - {{/_disableAffix}} -
-
- {{^_disableFooter}} - {{>partials/footer}} - {{/_disableFooter}} -
- {{>partials/scripts}} - - {{/redirect_url}} - diff --git a/Docs/templates/discordfx/partials/class.header.tmpl.partial b/Docs/templates/discordfx/partials/class.header.tmpl.partial deleted file mode 100755 index aaa1160..0000000 --- a/Docs/templates/discordfx/partials/class.header.tmpl.partial +++ /dev/null @@ -1,104 +0,0 @@ -{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - -

{{>partials/title}}

-
{{{summary}}}
-
{{{conceptual}}}
-{{#inClass}} -
-
{{__global.inheritance}}
- {{#inheritance}} -
{{{specName.0.value}}}
- {{/inheritance}} -
{{name.0.value}}
- {{#derivedClasses}} -
{{{specName.0.value}}}
- {{/derivedClasses}} -
-{{/inClass}} -{{#implements.0}} -
-
{{__global.implements}}
-{{/implements.0}} -{{#implements}} -
{{{specName.0.value}}}
-{{/implements}} -{{#implements.0}} -
-{{/implements.0}} -
{{__global.namespace}}: {{{namespace.specName.0.value}}}
-
{{__global.assembly}}: {{assemblies.0}}.dll
-
{{__global.syntax}}
-
-
{{syntax.content.0.value}}
-
-{{#syntax.parameters.0}} -
{{__global.parameters}}
- - - - - - - - - -{{/syntax.parameters.0}} -{{#syntax.parameters}} - - - - - -{{/syntax.parameters}} -{{#syntax.parameters.0}} - -
{{__global.type}}{{__global.name}}{{__global.description}}
{{{type.specName.0.value}}}{{{id}}}{{{description}}}
-{{/syntax.parameters.0}} -{{#syntax.return}} -
{{__global.returns}}
- - - - - - - - - - - - - -
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
-{{/syntax.return}} -{{#syntax.typeParameters.0}} -
{{__global.typeParameters}}
- - - - - - - - -{{/syntax.typeParameters.0}} -{{#syntax.typeParameters}} - - - - -{{/syntax.typeParameters}} -{{#syntax.typeParameters.0}} - -
{{__global.name}}{{__global.description}}
{{{id}}}{{{description}}}
-{{/syntax.typeParameters.0}} -{{#remarks}} -
{{__global.remarks}}
-
{{{remarks}}}
-{{/remarks}} -{{#example.0}} -
{{__global.examples}}
-{{/example.0}} -{{#example}} -{{{.}}} -{{/example}} diff --git a/Docs/templates/discordfx/partials/class.memberpage.tmpl.partial b/Docs/templates/discordfx/partials/class.memberpage.tmpl.partial deleted file mode 100755 index 7302d6f..0000000 --- a/Docs/templates/discordfx/partials/class.memberpage.tmpl.partial +++ /dev/null @@ -1,46 +0,0 @@ -{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - -{{>partials/class.header}} -{{#children}} -{{#overload}} - -{{/overload}} -

{{>partials/classSubtitle}}

-{{#children.0}} - - - - - - - - - {{/children.0}} - {{#children}} - - - - - {{/children}} - {{#children.0}} - -
{{__global.name}}{{__global.description}}
- - {{{summary}}}
-{{/children.0}} -{{/children}} -{{#seealso.0}} -

{{__global.seealso}}

-
-{{/seealso.0}} -{{#seealso}} - {{#isCref}} -
{{{type.specName.0.value}}}
- {{/isCref}} - {{^isCref}} -
{{{url}}}
- {{/isCref}} -{{/seealso}} -{{#seealso.0}} -
-{{/seealso.0}} diff --git a/Docs/templates/discordfx/partials/class.tmpl.partial b/Docs/templates/discordfx/partials/class.tmpl.partial deleted file mode 100755 index 034dd6c..0000000 --- a/Docs/templates/discordfx/partials/class.tmpl.partial +++ /dev/null @@ -1,221 +0,0 @@ -{{!Licensed to the .NET Foundation under one or more agreements. The .NET Foundation licenses this file to you under the MIT license.}} - -{{>partials/class.header}} -{{#children}} -

{{>partials/classSubtitle}}

-{{#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}}
-
-{{#parameters.0}} -
{{__global.parameters}}
- - - - - - - - - -{{/parameters.0}} -{{#parameters}} - - - - - -{{/parameters}} -{{#parameters.0}} - -
{{__global.type}}{{__global.name}}{{__global.description}}
{{{type.specName.0.value}}}{{{id}}}{{{description}}}
-{{/parameters.0}} -{{#return}} -
{{__global.returns}}
- - - - - - - - - - - - - -
{{__global.type}}{{__global.description}}
{{{type.specName.0.value}}}{{{description}}}
-{{/return}} -{{#typeParameters.0}} -
{{__global.typeParameters}}
- - - - - - - - -{{/typeParameters.0}} -{{#typeParameters}} - - - - -{{/typeParameters}} -{{#typeParameters.0}} - -
{{__global.name}}{{__global.description}}
{{{id}}}{{{description}}}
-{{/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}} -{{#remarks}} -
{{__global.remarks}}
-
{{{remarks}}}
-{{/remarks}} -{{#example.0}} -
{{__global.examples}}
-{{/example.0}} -{{#example}} -{{{.}}} -{{/example}} -{{#exceptions.0}} -
{{__global.exceptions}}
- - - - - - - - -{{/exceptions.0}} -{{#exceptions}} - - - - -{{/exceptions}} -{{#exceptions.0}} - -
{{__global.type}}{{__global.condition}}
{{{type.specName.0.value}}}{{{description}}}
-{{/exceptions.0}} -{{#seealso.0}} -
{{__global.seealso}}
-
-{{/seealso.0}} -{{#seealso}} - {{#isCref}} -
{{{type.specName.0.value}}}
- {{/isCref}} - {{^isCref}} -
{{{url}}}
- {{/isCref}} -{{/seealso}} -{{#seealso.0}} -
-{{/seealso.0}} -{{/children}} -{{/children}} -{{#implements.0}} -

{{__global.implements}}

-{{/implements.0}} -{{#implements}} -
- {{#definition}} - - {{/definition}} - {{^definition}} - - {{/definition}} -
-{{/implements}} -{{#seealso.0}} -

{{__global.seealso}}

-
-{{/seealso.0}} -{{#seealso}} - {{#isCref}} -
{{{type.specName.0.value}}}
- {{/isCref}} - {{^isCref}} -
{{{url}}}
- {{/isCref}} -{{/seealso}} -{{#seealso.0}} -
-{{/seealso.0}} diff --git a/Docs/templates/discordfx/styles/main.css b/Docs/templates/discordfx/styles/main.css deleted file mode 100644 index 9a82142..0000000 --- a/Docs/templates/discordfx/styles/main.css +++ /dev/null @@ -1,21 +0,0 @@ -.sidenav { - position: sticky; - top: 0; - max-height: 100vh; -} - -.sidetoc { - height: 100vh; -} - -.inheritedMembers, -.extensionMethods { - display: none; -} - -.content.wrap h1, -.content.wrap h2, -.content.wrap h3, -.content.wrap h4 { - scroll-margin-top: 80px; -} diff --git a/Docs/toc.yml b/Docs/toc.yml index 099d393..0c76820 100644 --- a/Docs/toc.yml +++ b/Docs/toc.yml @@ -3,4 +3,4 @@ - name: Getting Started href: getting-started.md - name: API Reference - href: api/toc.yml + href: api/