Overview¶

Documentation¶

This Documentation is a quick guide for the most frequently used features in this template.
- It is a collection of the most used features from MkDocs-material for the learning materials at HAMK.
Mkdocs has a powerful search function.
- Please use the search box (in the header) to find a setting.
- If the topic not included in this site, please refer to the full documentation from Mkdocs-material below.

MkDocs(-material) external documentation¶

- MkDocs-material ( Getting started | Setup | Reference | Plugins)
- MkDocs-material Repository
- https://www.mkdocs.org/
- https://github.com/mkdocs/catalog
- Markdown Extensions

Template¶

The Template is prebuilt with HAMK colors and fonts, available for customization with your content.

Email placeholder¶

in the template, replace firstname.lastname@hamk.fi with your email

Replace the placeholder firstname.lastname@hamk.fi with your own email in 2 places
- Refer to the documentation setting up

Example pages¶

The BYOD page is an example of applying Mkdocs-material to the BYOD content.
This page itself is an example of using mkdocs-material.

Search ¶

Mkdocs-material has a strong search function.
Search for a tool or setting. If not covered in this documentation, look for it in the full documentations

Tip

Search 'nav' or 'toc' for setting.
Search 'integrate' for how to integrate the toc to the nav.

See more in setting up
- The left-side menu is called nav (navigation)
- The right-side menu is called the toc (table of content)
- For small pages (such as this one), the toc can be integrated into the nav (search integrate for guidance)