Skip to content

Commit

Permalink
📚 Docs for exclude during project toc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
fwkoch authored and rowanc1 committed Feb 22, 2024
1 parent ae929f1 commit f4f9db4
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions docs/table-of-contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,25 @@ The “root” of a site is the page displayed when someone browses to the index
All of these can be over-ridden by choosing an explicit `_toc.yml`, when that is present it will be used.
```

### Excluding Files

If there are markdown or notebook files within a project folder that you do not want included in your project, you may list these in the `myst.yml` project frontmatter under `exclude`. For example, to ignore a single file `notes.md`, all notebooks in the folder `hpc/`, and all files named `ignore.md`:

```yaml
project:
exclude:
- notes.md
- hpc/*.ipynb
- '**/ignore.md'
```
Additionally, files excluded in this way will also not be watched during `myst start`. This may be useful if you have a folder with a huge number of files (many thousands?) that causes `myst start` to crash. For example, in the `data/` directory, there may be no markdown and no notebooks but 100,000 small data files:

```yaml
project:
exclude: data/**
```

(toc-format)=

## Defining a `_toc.yml` using Jupyter Book’s format
Expand Down

0 comments on commit f4f9db4

Please sign in to comment.