The Guide Theme

Guide is an elegant and modern theme for documentation sites. Packed with dark mode, a toggleable sidebar, and intuitive navigation, it’s designed to make your documentation shine.

Guide is the most popular theme for Typemill right now and it is probably one of the most feature-rich documentation themes that you will find in the web. The theme is available with the Typemill MAKER license.

Demo and Screenshots

You can test the Guide theme at the demo instance under https://try.typemill.net or just check the documentation of Typemill that is build with the Guide theme. The theme provides several "readymades" in the theme settings so you can check variants of the theme with just one click.

Screenshot of the darkmode of the Guide theme for Typemill — *The Dark-Mode of the Guide Theme*

*Collapes side navigation and additional header navigation*

*Centered version with background color*

Toggle Dark Mode

The Guide theme includes a dark mode switch in the frontend. Clicking the sun icon switches to the dark color scheme,

clicking on the moon icon switches back to the light color scheme. You can customize both color schemes in the theme settings.

Users can toggle the sidebar in the frontend using an icon at the top. In mobile view, the logic is inverted — the page starts with the sidebar closed, and users can open it with a button.

Users can toggle the navigation in the frontend, and the browser will remember the last state of the navigation.

Customize Colors

You can customize both light and dark mode colors in the theme settings. To get a quick impression of what's possible, load one of the three readymade configurations at the top of the theme settings. Be sure to save the settings and preview the changes in the frontend. The available readymades are:

STANDARD: The default theme colors seen in the demo. Add your brand color to make it your own.
PASTEL: A colorful but soft pastel color scheme.
NEON: A bold, edgy design with funky neon colors. Ask your designer to create something unique.

More Customization Options

The Guide theme offers additional customization options, including:

Logo: Use an image logo and/or a text logo.
Fonts: Choose between system fonts for headlines and body text.
Headernavi: Optional header navigation with manual entries.
Navi Toggle: Optional button to toggle the navigation from open/close.
Content: Configure content elements like
- a breadcrumb.
- a print button.
- an edit button, which can link to a repository (e.g., GitHub).
- the publish date.
- the author name.
- next/previous page navigation links.
Footer: Add up to three footer columns and insert markdown.

Changelog

Version 1.3.4

Added Multi-Language Buttons in the sidebar

Version 1.3.2

Added option to add a folder-navigation below the content on the startpage
Added print styles
Escaped values in twig theme

Version 1.3.0

Optional header navigation with manual entries
Optional toggle button to open and close the left navigation.

Version 1.2.2

Add styles for frontend forms

Version 1.2.0

New option to add an edit button to the toolbar that leads to the typemill editor.
Better option to add a git edit box at the bottom of each article.
Option to show the left navigation in full height without a scrollbar.
Fix indent in navigation for deep structures.
Fix error in navigation with limited hight (cuts the navigation).

Version 1.1.0

New option for a centered layout with maximum width.
New options for background color.
Two new readymades (notion-like and boxed style).
New option to show the subnavigation of a folder below content.
New option to set default mode to dark or light
Moved print and edit buttons to toolbox
Fixed html-bug that destroyed first line of content.