Commit cebbaac
committed
🤖 refactor: use TypeDoc HTML instead of markdown for API reference
- Remove typedoc-plugin-markdown dependency
- Generate HTML to docs/api/ instead of markdown
- Update links in overview.md to point to TypeDoc HTML
- Remove api-reference.md from SUMMARY.md
- Simpler build process (no markdown conversion)
- Better UX: TypeDoc HTML has search, navigation tree, type links
- Reduces complexity and maintenance burden
Benefits:
- Professional API documentation with built-in features
- No need for Shiki preprocessing of API docs
- Separate concerns: user guides (mdBook) vs API reference (TypeDoc)
- Standard pattern used by most TypeScript libraries1 parent bf0d5f9 commit cebbaac
File tree
6 files changed
+13
-942
lines changed- docs
- extensions
6 files changed
+13
-942
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
118 | 118 | | |
119 | 119 | | |
120 | 120 | | |
| 121 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
277 | 277 | | |
278 | 278 | | |
279 | 279 | | |
280 | | - | |
| 280 | + | |
281 | 281 | | |
282 | 282 | | |
283 | | - | |
284 | | - | |
| 283 | + | |
285 | 284 | | |
286 | 285 | | |
287 | 286 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
25 | 24 | | |
26 | 25 | | |
27 | 26 | | |
| |||
0 commit comments