Skip to content

Commit 7f4c18c

Browse files
committed
Add mkdocs-nav-weight plugin and test it.
1 parent 0348e4c commit 7f4c18c

File tree

3 files changed

+12
-1
lines changed

3 files changed

+12
-1
lines changed

README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,11 @@ Documentation for the [Virtual Anatomy project](https://github.com/jrcz-data-sci
99

1010
First of all, ensure that you have `pip` and `python` packages installed.
1111

12-
Then, run the following command to install MkDocs:
12+
Then, run the following command to install MkDocs (and its plugin, necessary for appropriate display of the content):
1313

1414
```bash
1515
pip install mkdocs
16+
pip install mkdocs-nav-weight
1617
```
1718

1819
The material theme is used within this documentation. For the best UI experience install it using the following command:
@@ -39,6 +40,9 @@ If your file is located inside the `docs` folder it will get automatically inter
3940

4041
Once you are done with (part of) your documentation, `add` your changes, `commit`, and `push` them to `main` branch. The GitHub action will trigger, and the `gh-pages` branch will be updated with your changes (bot will deploy it as static website and push to the `gh-page` branch).
4142

43+
## Additional plugins for MkDocs
44+
- **`mkdocs-nav-weight`**: plugin that enables to organize sequence of mkdocs chapters/pages on the side navigation menu. ([Link](https://github.com/shu307/mkdocs-nav-weight?tab=readme-ov-file))
45+
4246
## Authors/Contributors
4347

4448
[Simon Potocnak](https://github.com/wpsimon09),

docs/VirtualAnatomy/Recomendations.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
---
2+
weight: 1
3+
---
4+
15
# Recomendations
26

37
This seciton covers some recomendations we have for you. If you find this taken out of context, it is. I have written this to my porfolio and i am putting it here for you so that you have some stepping stones while starting this project and to know, what should you focuse on. I hope i have covered most of the aspects that needs to be done. Keep in mind that this is only my (Simon's) recomendations. Daniel will hopefuly have his own paragraph later on.

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,9 @@ markdown_extensions:
1010
- attr_list
1111
- md_in_html
1212

13+
plugins:
14+
- search
15+
- mkdocs-nav-weight
1316

1417
copyright: <h3><i>© 2024-25 Joint Research Center Zeeland. All Rights Reserved.
1518

0 commit comments

Comments
 (0)