diff --git a/docs/Assignments/week_1_fabacademy/customising_mkdocs.md b/docs/Assignments/week_1_fabacademy/customising_mkdocs.md index 48b74f6..e654624 100644 --- a/docs/Assignments/week_1_fabacademy/customising_mkdocs.md +++ b/docs/Assignments/week_1_fabacademy/customising_mkdocs.md @@ -40,7 +40,9 @@ theme: accent: teal ``` Of yourse you could also use the extra.css to style the website even more. -### Extensions + + +## 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 @@ -49,8 +51,36 @@ markdown_extensions: permalink: true ``` +### Drop down menu's +With this extension you can add drop down menu's to your page. + +#### How do I install drop down menus? +Drop down menu's are part of the `pymdownx.details` extension. You need to place that in your `mkdocs.yml` under `markdown_extensions:` liket his: +```yaml +markdown_extensions: + - pymdownx.details +``` + +#### How do I use it +You can use it like this. Don't forget that you need to use 2 tabs to get the text in the collapsable box. +``` +??? Notes + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent lacinia rutrum nibh sit amet pharetra. Aenean in metus fringilla, varius nulla eu, malesuada nulla. Praesent placerat tortor lacus, nec sollicitudin felis elementum sit amet. Nam mollis tincidunt arcu ac gravida. Vivamus turpis nisi, lacinia in eleifend sed, interdum ultricies quam. +``` + +Result: + +??? Info + + Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent lacinia rutrum nibh sit amet pharetra. Aenean in metus fringilla, varius nulla eu, malesuada nulla. Praesent placerat tortor lacus, nec sollicitudin felis elementum sit amet. Nam mollis tincidunt arcu ac gravida. Vivamus turpis nisi, lacinia in eleifend sed, interdum ultricies quam. + + + + ### Links * [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 * [mkdocs extra css](https://www.mkdocs.org/user-guide/customizing-your-theme/) +* [docs about drop down menu's](https://facelessuser.github.io/pymdown-extensions/extensions/details/) diff --git a/docs/Assignments/week_1_fabacademy/markdown.md b/docs/Assignments/week_1_fabacademy/markdown.md index 391119a..c0df4c7 100644 --- a/docs/Assignments/week_1_fabacademy/markdown.md +++ b/docs/Assignments/week_1_fabacademy/markdown.md @@ -30,29 +30,6 @@ Basic markdown syntax ## Markdown conventions All markdown files must start with a `Head1` otherwise Mkdocs won't understand the file and the pipline will crash. -## Drop down menu's - -### How do I install drop down menus? -Drop down menu's are part of the `pymdownx.details` extension. You need to place that in your `mkdocs.yml` under `markdown_extensions:` liket his: -```yaml -markdown_extensions: - - pymdownx.details -``` - -### How do I use it -You can use it like this. Don't forget that you need to use 2 tabs to get the text in the collapsable box. -``` -??? Notes - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent lacinia rutrum nibh sit amet pharetra. Aenean in metus fringilla, varius nulla eu, malesuada nulla. Praesent placerat tortor lacus, nec sollicitudin felis elementum sit amet. Nam mollis tincidunt arcu ac gravida. Vivamus turpis nisi, lacinia in eleifend sed, interdum ultricies quam. -``` - -Result: - -??? Info - - Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent lacinia rutrum nibh sit amet pharetra. Aenean in metus fringilla, varius nulla eu, malesuada nulla. Praesent placerat tortor lacus, nec sollicitudin felis elementum sit amet. Nam mollis tincidunt arcu ac gravida. Vivamus turpis nisi, lacinia in eleifend sed, interdum ultricies quam. ## Sources * [markdown cheatsheet](https://www.markdownguide.org/cheat-sheet/) -* [docs about drop down menu's](https://facelessuser.github.io/pymdown-extensions/extensions/details/) \ No newline at end of file