Skip to content

Commit 127fc1d

Browse files
ikorotkinikorotkin
committed
Outline doc website structure
1 parent 05abf63 commit 127fc1d

File tree

12 files changed

+187
-3
lines changed

12 files changed

+187
-3
lines changed

‎docs/_config.yml‎

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,35 @@ url: https://dae-cpp.github.io
77
# For copy button on code
88
enable_copy_code_button: true
99

10+
# Top right links
1011
aux_links:
1112
"dae-cpp on GitHub":
1213
- "https://github.com/dae-cpp/dae-cpp"
1314

15+
# External navigation links
16+
nav_external_links:
17+
- title: dae-cpp on GitHub
18+
url: https://github.com/dae-cpp/dae-cpp
19+
hide_icon: false # set to true to hide the external link icon - defaults to false
20+
opens_in_new_tab: true # set to true to open this link in a new tab - defaults to false
21+
1422
# Makes Aux links open in a new tab.
1523
aux_links_new_tab: true
1624

1725
# Color scheme supports "light" (default) and "dark"
18-
color_scheme: dark
26+
color_scheme: light
27+
28+
# Back to top link
29+
back_to_top: true
30+
back_to_top_text: "Back to top"
1931

2032
# Footer content
2133
# Appears at the bottom of every page's main content
2234
footer_content: "Copyright &copy; 2024 Ivan Korotkin. Distributed by an <a href=\"https://github.com/dae-cpp/dae-cpp.github.io/blob/main/LICENSE\">MIT license.</a>"
2335

2436
# Footer last edited timestamp
25-
last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
26-
last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
37+
# last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter
38+
# last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html
2739

2840
# Footer "Edit this page on GitHub" link text
2941
gh_edit_link: true # show or hide edit this page link
@@ -32,3 +44,20 @@ gh_edit_repository: "https://github.com/dae-cpp/dae-cpp.github.io" # the github
3244
gh_edit_branch: "main" # the branch that your docs is served from
3345
gh_edit_source: docs # the source that your files originate from
3446
gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately
47+
48+
callouts_level: quiet # or loud
49+
callouts:
50+
highlight:
51+
color: yellow
52+
important:
53+
title: Important
54+
color: blue
55+
new:
56+
title: New
57+
color: green
58+
note:
59+
title: Note
60+
color: purple
61+
warning:
62+
title: Warning
63+
color: red

‎docs/assets/images/dae-cpp-01a.png‎

94.5 KB
Loading

‎docs/examples.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Examples
3+
layout: default
4+
nav_order: 10
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Examples
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/index.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,16 @@
11
---
22
title: Home
33
layout: home
4+
nav_order: 1
45
---
56

7+
Work in progress
8+
{: .label .label-red }
9+
10+
<p align="center">
11+
<img src="../assets/images/dae-cpp-01a.png" alt="dae-cpp logo" width="250"/>
12+
</p>
13+
614
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
715

816
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.

‎docs/jacobian-matrix.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Jacobian Matrix class
3+
layout: default
4+
nav_order: 5
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Jacobian Matrix class
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/mass-matrix.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Mass Matrix class
3+
layout: default
4+
nav_order: 3
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Mass Matrix class
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/solution-manager.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Solution Manager class
3+
layout: default
4+
nav_order: 6
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Solution Manager class
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/solve.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Solving DAE system
3+
layout: default
4+
nav_order: 8
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Solving DAE system
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/solver-options.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Solver Options class
3+
layout: default
4+
nav_order: 7
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Solver Options class
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

‎docs/sparse-matrix.md‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
---
2+
title: Sparse Matrix class
3+
layout: default
4+
nav_order: 2
5+
---
6+
7+
Work in progress
8+
{: .label .label-red }
9+
10+
# Sparse Matrix class
11+
12+
Text
13+
14+
## Subtitle
15+
16+
Text

0 commit comments

Comments
 (0)