mirror of
https://gitlab.waag.org/make/fablab/interns/2025/sam.git
synced 2025-08-03 20:04:56 +00:00
added more docs about material mkdocs
This commit is contained in:
@@ -1,4 +1,4 @@
|
|||||||
# Customising mkdocs
|
# Customising Mkdocs
|
||||||
|
|
||||||
I wanna customise my mkdocs theme. So I can have a dark mode. Because it currently looks like this and having a nice looking documentation page is necessary too!
|
I wanna customise my mkdocs theme. So I can have a dark mode. Because it currently looks like this and having a nice looking documentation page is necessary too!
|
||||||
|
|
||||||
@@ -29,15 +29,28 @@ extra_css: [extra.css]
|
|||||||
### Attempt 2
|
### Attempt 2
|
||||||
After I read the documentation thoroughly i found out that the css file needs to be relative to the `docs` folder and not the `mkdocs.yml`. After that it showed the css and I could finaly customise the theme.
|
After I read the documentation thoroughly i found out that the css file needs to be relative to the `docs` folder and not the `mkdocs.yml`. After that it showed the css and I could finaly customise the theme.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Customising Material theme
|
## Customising Material theme
|
||||||
I decided to switch to material theme because its easier to configure and you can add all sorts of modules onto it making it super customisable.
|
### Palette customisation
|
||||||
|
I decided to switch to material theme because its easier to configure. There are premade color schemes and a lot of extensions that work out of the box.
|
||||||
|
Example changing colors.
|
||||||
|
```yaml
|
||||||
|
theme:
|
||||||
|
palette:
|
||||||
|
primary: indigo
|
||||||
|
accent: teal
|
||||||
|
```
|
||||||
|
Of yourse you could also use the extra.css to style the website even more.
|
||||||
|
### Extensions
|
||||||
|
You can add lot's of extensions. For example code highlighting or a table of contents on the right side of your website.
|
||||||
|
This adds a table of contents. You can find all the extensions [here](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents).
|
||||||
|
```yaml
|
||||||
|
markdown_extensions:
|
||||||
|
- toc:
|
||||||
|
permalink: true
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
### Links
|
### Links
|
||||||
* https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents
|
* [markdown extensions](https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown/#table-of-contents)
|
||||||
* https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#table-of-contents
|
* https://squidfunk.github.io/mkdocs-material/setup/setting-up-navigation/#table-of-contents
|
||||||
|
* [mkdocs extra css](https://www.mkdocs.org/user-guide/customizing-your-theme/)
|
||||||
|
Reference in New Issue
Block a user