docs: migrate from MkDocs to VitePress + TypeDoc#4
Merged
royisme merged 1 commit intoNov 12, 2025
Merged
Conversation
- Remove redundant Documentation section from README.md and README.zh-CN.md - Replace MkDocs with VitePress for documentation site - Add TypeDoc for auto-generating API documentation from TypeScript source - Update docs workflow to use Bun and VitePress instead of Python/MkDocs - Add Mermaid diagram support to VitePress config - Update package.json scripts: - docs:api: Generate API docs with TypeDoc - docs:dev: Dev server with VitePress - docs:build: Build docs (TypeDoc + VitePress) - docs:preview: Preview built docs - Update .gitignore to exclude generated docs - Remove mkdocs.yml and package-lock.json - Update bun.lock with new dependencies (vitepress, typedoc, typedoc-plugin-markdown) VitePress provides better integration with TypeScript projects and allows combining hand-written guides with auto-generated API documentation.
royisme
deleted the
claude/fix-readme-duplicate-sections-011CV4kdnm2HBmK44MFzdKQK
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
VitePress provides better integration with TypeScript projects and allows combining hand-written guides with auto-generated API documentation.