📖 MkDocs Material: User's Guide
This document is for the end-user reading the generated documentation site.
Brief User Guide: Reading and Navigation
This documentation site is built using MkDocs Material, which focuses on fast loading, clean presentation, and highly effective searching.
This site is configured to use Roboto and Roboto Mono fonts for readability.
🔎 Finding Information
The site provides two primary tools for navigation and finding content: the sidebar menu and the powerful search bar.
1. The Sidebar Menu (Navigation)
The menu on the left side of the screen is generated from the site's structure defined in the mkdocs.yml configuration file.
- Top-Level Sections: Sections like "Nouvelle France" or "Prussian German" act as navigation headers. Clicking these will load that section's main landing page (
index.mdor equivalent). - Active Pages: The page you are currently viewing will be highlighted with a distinct color in the sidebar.
- Expansion Persistence: The menu will remain expanded to the section path of the page you are viewing, even after navigating to a deep link.
2. The Full-Text Search Bar
The search bar, located at the top of the page (or sidebar on larger screens), is the primary tool for finding information across all documents.
- How to Use: Start typing a keyword, phrase, or title. Results will appear dynamically, showing you the title and a snippet of the surrounding text where your query was found.
- Immediate Results: Results appear instantly as you type. Click a result to navigate to that page.
3. Further Reading
For a complete overview of all the features available in this documentation platform, refer to the official theme documentation:
🎨 Customizing the View
The MkDocs Material theme includes a toggle for user comfort.
Theme Toggle
Click the Switch to Dark Mode or Switch to Light Mode button (an icon of a sun or moon) located in the upper right header row.
- This instantly toggles the site between Light Mode and Dark Mode.
- The system remembers your selection across sessions using your browser's local storage.
⚖️ Credits
Platform: MkDocs Material Theme Design & Layout developed by Mark Rabideau. Code Development by Gemini & Khoj.