title | description |
---|---|
Customizing pages |
Learn how to get the most out of UnMarkDocs |
Page customization is done using Front Matter. Front Matter is a yaml-like block you can add to the top of your Markdown files separated by three hypens:
---
config1: myvalue
moreComplexSetting:
toggle1: true
title: My Title
anotherSetting: 1
---
# Your Markdown file starts here
UnMarkDocs offers a wide range of options you can customize in every page.
Controls the title of the page.
title: My awesome page
!!! info
If you don't specify a title, we'll try to guess it from your file. !!!
Controls the description of the page
description: This page is very useful
Allows you to provide a *[CTA]: [Call to Action] to a URL or another page of the documentation at the bottom of the current page.
There are two ways to use this option:
next: slug-of-another-page # Or a URL
next:
url: slug-of-another-page # Or a URL
copy: Text to add to the bottom of the page instead of the default
Allows to protect the page content with a numeric pin. The content of the page will be obfuscated, and the user will be requred to enter your code to view it.
pin: 1234
Allows to use Mathjax in the page. When enabled, you can add mathjax code by surrounding it with $
or $$
.
mathjax: true
Rewrites all links on the page to Rick Astley's Never Gonna Give You Up video.
rickroll: true
Allows to specify a URL or another page of the documentation the user will be redirected to upon entering the Konami Code.
konami: true