Skip to content

Plugins

Plugins run at build time and add features that go beyond Markdown rendering. None of them require special syntax in your pages unless noted.

Built-in full-text search. The search bar in the header is provided by this plugin — no configuration needed. Three theme features extend it:

  • search.suggest — autocompletes as you type
  • search.highlight — highlights the search term on the result page
  • search.share — adds a share button to copy a search URL

To exclude a page from search results, add this to its front matter:

---
search:
  exclude: true
---

awesome-pages

Controls navigation order using .pages files placed inside any folder. Without a .pages file, MkDocs falls back to alphabetical order.

Basic .pages file:

title: My Section
nav:
  - index.md
  - setup.md
  - advanced.md

Inserting a separator (renders as a line in the sidebar):

nav:
  - index.md
  - ...             # remaining pages auto-fill here

Nesting a subfolder:

nav:
  - index.md
  - Sub Section: subfolder

The title key overrides the section label that appears in the nav. If omitted, the folder name is used.

tags

Lets you tag pages and generates a tags index. Add tags to any page's front matter:

---
tags:
  - Windows
  - Networking
---

To display the tags index, create a page containing only this:

# Tags
[TAGS]

glightbox

Automatically wraps every image in a lightbox — click any image to open it full-size with zoom and keyboard navigation. No special syntax required; standard Markdown image syntax is enough:

![Alt text](path/to/image.png)

To disable the lightbox on a specific image, add the { data-glightbox="none" } attribute:

![Alt text](path/to/image.png){ data-glightbox="none" }

(Requires attr_list extension, which is enabled.)

git-revision-date-localized

Reads the Git history to display a "last updated" and "created" date at the bottom of each page. Configured with:

  • enable_creation_date: true — shows the first-commit date as well as the last-modified date
  • fallback_to_build_date: true — uses the build time if the file has no Git history (safe before the repo is connected)
  • timezone: Australia/Melbourne — localises the displayed timestamps

Nothing to add to page content — dates appear automatically.

social

Auto-generates Open Graph social preview cards (the images shown when you share a link on Slack, Teams, etc.). Picks up site_name and the page title from properdocs.yml. No per-page action needed.

To customise the card description for a specific page, add a description key to its front matter:

---
description: A short sentence shown in the social card preview.
---

privacy

Automatically downloads and self-hosts external assets (fonts, scripts, stylesheets) that are referenced in your pages or configuration. This means no third-party requests leave the browser when someone reads the docs.

Fully automatic — nothing to configure per page.

minify

Compresses the generated HTML at build time to reduce page size. Configured with minify_html: true. Transparent to editors — no effect on how you write content.