Skip to content

Commit a8a2ed3

Browse files
committed
write README
1 parent fc94b1b commit a8a2ed3

File tree

2 files changed

+3
-17
lines changed

2 files changed

+3
-17
lines changed

README.md

Lines changed: 3 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,7 @@
11
# rehype-toc
22

3-
## Development
3+
rehype plugin to generate a table of contents from headings in your markdown.
44

5-
- Install dependencies:
5+
You can create the table of contents such below.
66

7-
```bash
8-
pnpm install
9-
```
10-
11-
- Run the unit tests:
12-
13-
```bash
14-
pnpm run test
15-
```
16-
17-
- Build the library:
18-
19-
```bash
20-
pnpm run build
21-
```
7+
![A table of contents whose each items are anchor link.](assets/toc.png)

assets/toc.png

50 KB
Loading

0 commit comments

Comments
 (0)