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.

✨ If You want to use a sub route for example /docs as main content directory you need setup two steps.

app.config.ts

export default defineAppConfig({
  stand: {
    contentRoot: 'docs', // default is 'null'
  },
});

Frontmatter

Docus supports multiple Front-matter attributes for pages.

index.md

---
title: "Get Started"
description: "Let's learn how to use my amazing module."
---

Key	Type	Default	Description
`layout`	`string`	false	Use any layout name like you would in `definePageMeta()`
`title`	`string`		Defines the page title and H1 in docs pages
`description`	`string`		Defines the page description and excerpt in docs pages
`redirect`	`string`		A route path to redirect
`image`	`object`		OpenGraph cover image
Docs layout options
`fluid`	`boolean`	false	Toggles the visibility navigation,contents,surround
`aside`	`boolean`	true	Toggles the visibility of aside navigation
`toc`	`boolean`	true	Toggles the visibility of table of contents
`surround`	`boolean`	true	Toggle the visibility of table of surround (Prev,Next)
Navigation options
`navigation`	`boolean`		Toggles the visibility of the page or directory in navigation
`navigation.title`	`string`		Changes the name of the page or directory in navigation
`navigation.icon`	`string`		Changes the icon of the page or directory in navigation