added the why to use some stuff and gitignore

This commit is contained in:
2025-01-27 19:11:51 +01:00
parent f3d04a368d
commit 54c2b78de6
4 changed files with 6 additions and 5 deletions

View File

@@ -0,0 +1,43 @@
# 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!
![alt text](../assets/customising_mkdocs.jpg)
## Issues
### Attempt 1
I tried changing it by referencing extra css but when it builded i looked through the job artifacts and I saw that it didnt pick up on the file
```yml
site_name: Fab Academy docs page - Sam
site_url: https://pages.gitlab.io/mkdocs
site_dir: public
theme:
name: ivory
extra_css: [extra.css]
```
```css
.footer-note {
color:rgb(47, 44, 44) !important
}
.home .version {
color:rgb(47, 44, 44) !important
}
```
### 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.
## 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.
### Links
* 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