Skip to content

Commit 2cad6c3

Browse files
committed
chore: Make the code-docs index page show the class hierarch - and some other useful lines
1 parent 64334b6 commit 2cad6c3

File tree

2 files changed

+16
-0
lines changed

2 files changed

+16
-0
lines changed

src/README-code-docs.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- This file is embedded in the documentation generated by running 'yarn code-docs' -->
2+
3+
# Index
4+
5+
## Useful pages in this machine-generated documentation
6+
7+
- [Class Hierarchy](hierarchy.html)
8+
- [Modules](modules.html)
9+
10+
## External pages
11+
12+
- [GitHub repository](https://github.com/obsidian-tasks-group/obsidian-tasks)
13+
- [Contributing Guide](https://publish.obsidian.md/tasks-contributing/)
14+
- [Structure of the code](https://publish.obsidian.md/tasks-contributing/Code/Structure+of+the+code)
15+
- [User Guide](https://publish.obsidian.md/tasks/)

tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@
4545
],
4646
"typedocOptions": {
4747
"name": "Tasks plugin",
48+
"readme": "src/README-code-docs.md",
4849
"excludePrivate": false,
4950
"excludeProtected": false,
5051
"out": "code-docs",

0 commit comments

Comments
 (0)