Writing

Write documentation using markdown and MDX.

Markdown

Standard markdown syntax is fully supported:

# heading 1

## Heading 2

### Heading 3

**bold** and _italic_ text

- unordered
- list

1. ordered
2. list

[link](https://example.com)

![image](/image.png)

> blockquote

`inline code`

MDX

Use React components directly in MDX files:

text

<Callout type="info">
  this is a callout component.
</Callout>

Components are available globally via the MDX config.

Code blocks

Syntax highlighting with language detection:

```typescript
const hello = "world";
```

Add a title to code blocks:

```typescript title="app.ts"
const app = new App();
```

Twoslash

Enable twoslash annotations in fenced code blocks with the twoslash meta flag:

```ts twoslash
const value = "fromsrc"
value.
//    ^| string methods
```

fromsrc parses twoslash markers and renders typed query/completion notes under the code block.

const value = "fromsrc"
value.
//    ^| string methods

Frontmatter

Every MDX file needs frontmatter:

yaml

---
title: page title
description: page description
order: 1
---

Fields

field	type	required	description
title	string	yes	page title
description	string	no	SEO description
order	number	no	sort order in sidebar

File structure

Organize docs by topic:

docs/
  index.mdx           # introduction
  quickstart.mdx      # getting started
  components/
    callout.mdx
    tabs.mdx
  guides/
    theming.mdx
    deploying.mdx

Links

Link to other pages using relative paths:

see the [installation guide](/docs/installation)

External links automatically get an icon:

check out [GitHub](https://github.com)

Math

Write math equations using LaTeX syntax. fromsrc includes Math components powered by KaTeX.

Usage

text

<InlineMath>E = mc^2</InlineMath>

<BlockMath>x^2 + y^2 = z^2</BlockMath>

Math components are available globally.

Write documentation using markdown and MDX.

Markdown

Standard markdown syntax is fully supported:

# heading 1

## Heading 2

### Heading 3

**bold** and _italic_ text

- unordered
- list

1. ordered
2. list

[link](https://example.com)

![image](/image.png)

> blockquote

`inline code`

MDX

Use React components directly in MDX files:

text

<Callout type="info">
  this is a callout component.
</Callout>

Components are available globally via the MDX config.

Code blocks

Syntax highlighting with language detection:

```typescript
const hello = "world";
```

Add a title to code blocks:

```typescript title="app.ts"
const app = new App();
```

Twoslash

Enable twoslash annotations in fenced code blocks with the twoslash meta flag:

```ts twoslash
const value = "fromsrc"
value.
//    ^| string methods
```

fromsrc parses twoslash markers and renders typed query/completion notes under the code block.

const value = "fromsrc"
value.
//    ^| string methods

Frontmatter

Every MDX file needs frontmatter:

yaml

---
title: page title
description: page description
order: 1
---

Fields

field	type	required	description
title	string	yes	page title
description	string	no	SEO description
order	number	no	sort order in sidebar

File structure

Organize docs by topic:

docs/
  index.mdx           # introduction
  quickstart.mdx      # getting started
  components/
    callout.mdx
    tabs.mdx
  guides/
    theming.mdx
    deploying.mdx

Links

Link to other pages using relative paths:

see the [installation guide](/docs/installation)

External links automatically get an icon:

check out [GitHub](https://github.com)

Math

Write math equations using LaTeX syntax. fromsrc includes Math components powered by KaTeX.

Usage

text

<InlineMath>E = mc^2</InlineMath>

<BlockMath>x^2 + y^2 = z^2</BlockMath>

Math components are available globally.