Skip to content

Commit c4be6f6

Browse files
committed
doc: update table of contents
1 parent 0d02594 commit c4be6f6

File tree

2 files changed

+16
-10
lines changed

2 files changed

+16
-10
lines changed

.mise.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ uv run pytest
1010
uv run mypy .
1111
uv run ruff format --check
1212
"""
13-
13+
doctoc = "doctoc --notitle --maxlevel 2 README.md"

README.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,20 @@ Anki. It does not require Anki to be running at the same time.
1212

1313
### Table of Contents
1414

15-
* [Install instructions](#install-instructions)
16-
* [Usage](#usage)
17-
* [Configuration](#configuration)
18-
* [Zsh completion](#zsh-completion)
19-
* [fish completion](#fish-completion)
20-
* [Changelog](#changelog)
21-
* [Relevant resources](#relevant-resources)
22-
* [Alternatives](#alternatives)
15+
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
16+
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
17+
18+
- [Install instructions](#install-instructions)
19+
- [Usage](#usage)
20+
- [Examples of adding new notes](#examples-of-adding-new-notes)
21+
- [Configuration](#configuration)
22+
- [Zsh completion](#zsh-completion)
23+
- [Fish completion](#fish-completion)
24+
- [Relevant resources](#relevant-resources)
25+
- [Alternatives](#alternatives)
26+
- [Contributing](#contributing)
27+
28+
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2329

2430
## Install instructions
2531

@@ -102,7 +108,7 @@ apy review cid:12345678
102108
improve the process of adding and editing cards. For more information about
103109
this, see [the Wiki](https://github.com/lervag/apy/wiki/Vim).
104110

105-
## Examples of new cards
111+
## Examples of adding new notes
106112

107113
With `apy add` and `apy add-from-file`, the note input is provided through
108114
Markdown format. `apy add` opens an interactive editor that will write

0 commit comments

Comments
 (0)