Skip to content

Commit

Permalink
Update documentation site
Browse files Browse the repository at this point in the history
- Add Guide section and move to it everything in the Articles section
- Add custom template
- Various minor changes
  • Loading branch information
HamletTanyavong committed Oct 27, 2023
1 parent a819ab8 commit 900f99d
Show file tree
Hide file tree
Showing 11 changed files with 101 additions and 24 deletions.
3 changes: 3 additions & 0 deletions docs/articles/differential_geometry/tensors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Tensors

[work in progress]
2 changes: 1 addition & 1 deletion docs/articles/intro.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Mathematics.NET Articles

Welcome to Mathematics.NET.
This section is dedicated to highlighting areas of math covered in this library.
10 changes: 3 additions & 7 deletions docs/articles/toc.yml
Original file line number Diff line number Diff line change
@@ -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
17 changes: 4 additions & 13 deletions docs/docfx.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": [
Expand All @@ -49,7 +39,8 @@
"fileMetadataFiles": [],
"template": [
"default",
"modern"
"modern",
"template"
],
"postProcessors": [ "ExtractSearchIndex" ],
"keepFileLink": false,
Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 3 additions & 0 deletions docs/guide/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Mathematics.NET Guide

Welcome to Mathematics.NET.
10 changes: 10 additions & 0 deletions docs/guide/toc.yml
Original file line number Diff line number Diff line change
@@ -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
58 changes: 58 additions & 0 deletions docs/template/public/main.css
Original file line number Diff line number Diff line change
@@ -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;
}
15 changes: 15 additions & 0 deletions docs/template/public/main.js
Original file line number Diff line number Diff line change
@@ -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'
}
]
}
7 changes: 4 additions & 3 deletions docs/toc.yml
Original file line number Diff line number Diff line change
@@ -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

0 comments on commit 900f99d

Please sign in to comment.