Writing Pages

Docus is made to let you write all your content in Markdown and Vue components with the MDC syntax.

Each Markdown pages in the content/ folder will be mapped to a route.

FileGenerated route
index.md/
about.md/about
blog/index.md/blog
blog/hello.md/blog/hello
1.guide/2.installation/guide/installation

Frontmatter

Docus supports multiple Front-matter attributes for pages.

index.md
---
title: "Get Started"
description: "Let's learn how to use my amazing module."
---
KeyTypeDefaultDescription
layoutstringdefaultUse any layout name like you would in definePageMeta()
titlestringDefines the page title and H1 in docs pages
descriptionstringDefines the page description and excerpt in docs pages
redirectstringA route path to redirect
imageobjectOpenGraph cover image
Docs layout options
asidebooleanToggles the visibility of aside navigation
tocbooleanToggles the visibility of table of contents
headerbooleanToggles the visibility of the page header
bottombooleanToggles the visibility of page bottom section
Navigation options
navigationbooleanToggles the visibility of the page or directory in navigation
navigation.titlestringChanges the name of the page or directory in navigation
navigation.iconstringChanges the icon of the page or directory in navigation