Markdown

Docyard uses GitHub Flavored Markdown (GFM). If you’ve written a README, you already know the basics.

Text Formatting

**Bold text** and *italic text*

~~Strikethrough~~ and `inline code`

[Link text](https://example.com)

Bold text and italic text

Strikethrough and inline code

Link text

Headings

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Headings automatically generate anchor links. ## Getting Started becomes #getting-started.

Lists

- First item
- Second item
  - Nested item
  - Another nested item
- Third item

1. First step
2. Second step
3. Third step

• First item
• Second item
  • Nested item
  • Another nested item
• Third item

1. First step
2. Second step
3. Third step

Code Blocks

Use triple backticks with a language identifier:

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

function greet(name) {
  return `Hello, ${name}!`;
}

See Code Blocks for line highlighting, titles, and more.

Tables

| Name | Role | Status |
|------|------|--------|
| Alice | Admin | Active |
| Bob | Editor | Active |
| Carol | Viewer | Pending |

Blockquotes

> Documentation is a love letter to your future self.
>
> — Damian Conway

Documentation is a love letter to your future self.

— Damian Conway

Images

![Alt text](/images/screenshot.png)

Place images in docs/public/ and reference them with absolute paths.

Horizontal Rules

---

Creates a visual separator between sections.

Frontmatter

Every page starts with YAML frontmatter:

---
title: Page Title
description: A brief description for SEO and social sharing
---

See Frontmatter Reference for all options.

Custom Anchors

Override auto-generated heading anchors:

## My Heading {#custom-id}

Link to it with [text](#custom-id).

Abbreviations

Define abbreviations once, use them everywhere:

The HTML specification is maintained by the W3C.

*[HTML]: HyperText Markup Language
*[W3C]: World Wide Web Consortium

The HTML specification is maintained by the W3C.

Hover over the abbreviations above to see their definitions.