|
| 1 | +# Writing Pages |
| 2 | + |
| 3 | +Docus is made to let you write all your content in Markdown and Vue components with the MDC syntax. |
| 4 | + |
| 5 | +Each Markdown pages in the `content/` folder will be mapped to a route. |
| 6 | + |
| 7 | +| File | Generated route | |
| 8 | +| ------------------------ | :-------------------- | |
| 9 | +| `index.md` | `/` | |
| 10 | +| `about.md` | `/about` | |
| 11 | +| `blog/index.md` | `/blog` | |
| 12 | +| `blog/hello.md` | `/blog/hello` | |
| 13 | +| `1.guide/2.installation` | `/guide/installation` | |
| 14 | + |
| 15 | +## Frontmatter |
| 16 | + |
| 17 | +Docus supports multiple Front-matter attributes for pages. |
| 18 | + |
| 19 | +```md [index.md] |
| 20 | +--- |
| 21 | +title: "Get Started" |
| 22 | +description: "Let's learn how to use my amazing module." |
| 23 | +--- |
| 24 | +``` |
| 25 | + |
| 26 | +| **Key** | **Type** | **Default** | **Description** | |
| 27 | +| ----------------------- | --------- | ----------- | ------------------------------------------------------------- | |
| 28 | +| `layout` | `string` | `default` | Use any layout name like you would in `definePageMeta()` | |
| 29 | +| `title` | `string` | | Defines the page title and H1 in docs pages | |
| 30 | +| `description` | `string` | | Defines the page description and excerpt in docs pages | |
| 31 | +| `redirect` | `string` | | A route path to redirect | |
| 32 | +| `image` | `object` | | OpenGraph cover image | |
| 33 | +| **Docs layout options** | | | | |
| 34 | +| `aside` | `boolean` | | Toggles the visibility of aside navigation | |
| 35 | +| `toc` | `boolean` | | Toggles the visibility of table of contents | |
| 36 | +| `header` | `boolean` | | Toggles the visibility of the page header | |
| 37 | +| `bottom` | `boolean` | | Toggles the visibility of page bottom section | |
| 38 | +| **Navigation options** | | | | |
| 39 | +| `navigation` | `boolean` | | Toggles the visibility of the page or directory in navigation | |
| 40 | +| `navigation.title` | `string` | | Changes the name of the page or directory in navigation | |
| 41 | +| `navigation.icon` | `string` | | Changes the icon of the page or directory in navigation | |
0 commit comments