Skip to content

Commit

Permalink
docs: add note about yaml
Browse files Browse the repository at this point in the history
  • Loading branch information
agoose77 committed Aug 1, 2024
1 parent c14828b commit 7043265
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,19 @@ in order to be able to use the `myst` builder, e.g.
sphinx-build -b myst . <BUILDDIR>
```

The generated `.myst.json` files in `<BUILDDIR>/content` can be added to your TOC e.g. using a `pattern` entry. You can also serve the `myst.xref.json` from your Sphinx deployment to enable MyST xrefs.
The generated `.myst.json` files in `<BUILDDIR>/content` can be added to your TOC e.g. using a `pattern` entry, e.g.

```
project:
toc:
- file: index.md
- title: Sphinx Build
children:
- pattern: <BUILDDIR>/content/**.myst.json
```

You can also serve the `myst.xref.json` from your Sphinx deployment to enable MyST xrefs.

> [!WARNING]
> This extension is a literal work-in-progress; some things don't work.
Expand Down

0 comments on commit 7043265

Please sign in to comment.