Skip to content

Commit cebbaac

Browse files
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 libraries
1 parent bf0d5f9 commit cebbaac

File tree

6 files changed

+13
-942
lines changed

6 files changed

+13
-942
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,3 +118,4 @@ docs/theme/pagetoc.css
118118
docs/theme/pagetoc.js
119119
# Generated documentation theme assets
120120
docs/theme/code-blocks.css
121+
docs/api/

Makefile

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -277,11 +277,10 @@ docs-build: docs-api ## Build documentation (with Shiki preprocessor)
277277
docs-watch: ## Watch and rebuild documentation
278278
@cd docs && mdbook watch
279279

280-
docs-api: ## Generate extension API reference documentation
280+
docs-api: ## Generate extension API reference documentation (HTML)
281281
@echo "$(BLUE)Generating extension API documentation...$(RESET)"
282282
@bun x typedoc
283-
@mv docs/extensions/README.md docs/extensions/api-reference.md 2>/dev/null || true
284-
@echo "$(GREEN)✓ API documentation generated in docs/extensions/api-reference.md$(RESET)"
283+
@echo "$(GREEN)✓ API documentation generated in docs/api/$(RESET)"
285284

286285
## Storybook
287286
storybook: node_modules/.installed ## Start Storybook development server

docs/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@
2121
- [Project Secrets](./project-secrets.md)
2222
- [Agentic Git Identity](./agentic-git-identity.md)
2323
- [Extensions](./extensions/overview.md)
24-
- [API Reference](./extensions/api-reference.md)
2524

2625
# Advanced
2726

0 commit comments

Comments
 (0)