Skip to content

2.0.0 YAML Configuration
Compare
Choose a tag to compare
@dniccum dniccum released this 25 Oct 15:28
· 77 commits to master since this release
v2.0.0
413db78
This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
GPG key ID: 4AEE18F83AFDEB23
Expired
Learn about vigilant mode.

Adds the ability to add YAML configuration to the top of your documentation to modify how it appears and is loaded into your application.

If you are using the yaml parsing method, you have the OPTIONAL ability to customize how each page is built and shown within the sidebar. You can modify the following attributes:

  • title - The title of the page within the sidebar
  • path - The path/route/link of the page. Provide a valid URL
  • order - The order in which this page will appear in the sidebar

Example

---
title: "Adding Content"
path: content
order: 2
---

# Adding content to your application

...
Assets 2
Loading