markdown_module
Renders a markdown file from /docs/public/ inline on a page. Parsed with Parsedown. For times when we want to ship documentation alongside the site without round-tripping through the CMS — e.g. a public site map, third-party acknowledgements.
Markdown Style Guide Example
This is a simple example document to demonstrate markdown rendering.
Headings
You can use headings from H1 through H6 to organize content.
This is an H3
This is an H4
Paragraphs
Regular paragraphs are separated by blank lines. This makes the content easy to read and edit in both markdown and rendered HTML.
You can have multiple paragraphs like this one. Just add a blank line between them.
Lists
Unordered Lists
- First item
- Second item
- Third item
- Nested item
- Another nested item
- Back to top level
Ordered Lists
- First step
- Second step
- Third step
- Substep A
- Substep B
- Fourth step
Code
Inline code looks like this: const greeting = "Hello World".
Code blocks look like this:
function greet(name) {
console.log(`Hello, ${name}!`);
}Emphasis
You can use bold text for emphasis or italic text for subtle emphasis.
Links
This is a link to Perpetual Education.
Blockquotes
This is a blockquote. It's useful for calling out important information or highlighting quotes from other sources.
Horizontal Rules
You can add visual breaks with horizontal rules:
That's It!
This covers the most common markdown elements you'll use in documentation.