diff --git a/docs/articles/differential_geometry/tensors.md b/docs/articles/differential_geometry/tensors.md new file mode 100644 index 00000000..1d21ed3e --- /dev/null +++ b/docs/articles/differential_geometry/tensors.md @@ -0,0 +1,3 @@ +# Tensors + +[work in progress] diff --git a/docs/articles/intro.md b/docs/articles/intro.md index 1250a50b..123cbbdc 100644 --- a/docs/articles/intro.md +++ b/docs/articles/intro.md @@ -1,3 +1,3 @@ # Mathematics.NET Articles -Welcome to Mathematics.NET. +This section is dedicated to highlighting areas of math covered in this library. diff --git a/docs/articles/toc.yml b/docs/articles/toc.yml index 6aa3a720..1be43761 100644 --- a/docs/articles/toc.yml +++ b/docs/articles/toc.yml @@ -1,10 +1,6 @@ - name: Introduction href: intro.md -- name: Get Started +- name: Differential Geometry items: - - name: Installation - href: get_started/installation.md -- name: Fundamentals - items: - - name: Numeric Types - href: fundamentals/numeric-types.md + - name: Tensors + href: differential_geometry/tensors.md diff --git a/docs/docfx.json b/docs/docfx.json index 66202be3..7f5ad5dd 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -23,18 +23,8 @@ "build": { "content": [ { - "files": [ - "api/**.yml", - "api/index.md" - ] - }, - { - "files": [ - "articles/**.md", - "articles/**/toc.yml", - "toc.yml", - "*.md" - ] + "files": [ "**/*.{md,yml}" ], + "exclude": [ "_site/**", "obj/**" ] } ], "resource": [ @@ -49,7 +39,8 @@ "fileMetadataFiles": [], "template": [ "default", - "modern" + "modern", + "template" ], "postProcessors": [ "ExtractSearchIndex" ], "keepFileLink": false, diff --git a/docs/articles/fundamentals/numeric-types.md b/docs/guide/fundamentals/numeric-types.md similarity index 100% rename from docs/articles/fundamentals/numeric-types.md rename to docs/guide/fundamentals/numeric-types.md diff --git a/docs/articles/get_started/installation.md b/docs/guide/get_started/installation.md similarity index 100% rename from docs/articles/get_started/installation.md rename to docs/guide/get_started/installation.md diff --git a/docs/guide/intro.md b/docs/guide/intro.md new file mode 100644 index 00000000..32db6ab2 --- /dev/null +++ b/docs/guide/intro.md @@ -0,0 +1,3 @@ +# Mathematics.NET Guide + +Welcome to Mathematics.NET. diff --git a/docs/guide/toc.yml b/docs/guide/toc.yml new file mode 100644 index 00000000..6aa3a720 --- /dev/null +++ b/docs/guide/toc.yml @@ -0,0 +1,10 @@ +- name: Introduction + href: intro.md +- name: Get Started + items: + - name: Installation + href: get_started/installation.md +- name: Fundamentals + items: + - name: Numeric Types + href: fundamentals/numeric-types.md diff --git a/docs/template/public/main.css b/docs/template/public/main.css new file mode 100644 index 00000000..a93fbd59 --- /dev/null +++ b/docs/template/public/main.css @@ -0,0 +1,58 @@ +:root, [data-bs-theme="dark"] { + --bg-color-primary: #161616; + --bg-color-secondary: #082424; +} + +[data-bs-theme="light"] { + --bg-color-primary: #e4e4e4; + --bg-color-secondary: #b4f8f8; +} + +header { + --bs-border-width: 0px; +} + +body { + background-color: var(--bg-color-primary); +} + + body > footer { + display: flex; + align-items: center; + padding: 0rem; + height: 3rem; + } + +footer { + background-color: var(--bg-color-secondary); + font-size: 0.75rem; +} + + footer.border-top{ + border-top: 0px; + } + +a { + text-decoration: none; +} + + a:hover { + text-decoration: underline; + } + +.bg-body { + background-color: var(--bg-color-secondary); +} + +.dropdown a:hover { + text-decoration: none; +} + +.dropdown-menu[data-bs-popper] { + background-color: var(--bg-color-secondary); + margin-top: 1.125rem; +} + + .dropdown-menu a:hover { + text-decoration: none; + } diff --git a/docs/template/public/main.js b/docs/template/public/main.js new file mode 100644 index 00000000..406f4a3a --- /dev/null +++ b/docs/template/public/main.js @@ -0,0 +1,15 @@ +export default { + defaultTheme: 'dark', + iconLinks: [ + { + icon: 'github', + href: 'https://github.com/HamletTanyavong/Mathematics.NET', + title: 'GitHub' + }, + { + icon: 'heart', + href: 'https://github.com/sponsors/HamletTanyavong', + title: 'Sponsor' + } + ] +} diff --git a/docs/toc.yml b/docs/toc.yml index 59f80104..eeecad23 100644 --- a/docs/toc.yml +++ b/docs/toc.yml @@ -1,5 +1,6 @@ +- name: Guide + href: guide/ +- name: API + href: api/ - name: Articles href: articles/ -- name: Api Documentation - href: api/ - homepage: api/index.md