docs: Migrate Documentation System from MkDocs to VitePress - #178
Merged
Conversation
- Replaced MkDocs with VitePress for documentation. - Converted Markdown files to VitePress-compatible syntax (admonitions, code groups). - Updated home page with VitePress home layout. - Refactored Sudoku interactive example to work with VitePress/Vue. - Updated project dependencies and .gitignore.
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation from MkDocs to VitePress, modernizing the documentation system with a Vue-based static site generator. The migration includes converting Markdown syntax, refactoring interactive examples, and updating build configurations.
Key Changes:
- Replaced MkDocs with VitePress for documentation generation
- Converted Markdown syntax (MkDocs admonitions → VitePress containers, Material tabs → VitePress code groups)
- Refactored the Sudoku interactive example to work with VitePress/Vue
- Updated dependencies and configuration files
Reviewed changes
Copilot reviewed 16 out of 18 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| package.json | Added VitePress, Vue, ejs, and markdown-it-mathjax3 dependencies; added docs scripts |
| pyproject.toml | Removed MkDocs dependencies (mkdocs, mkdocs-material, mike) |
| package-lock.json | Updated lockfile with VitePress ecosystem dependencies |
| mkdocs.yml | Deleted MkDocs configuration file |
| .vitepress/config.mts | New VitePress configuration with nav, sidebar, and Vite settings |
| docs/index.md | Converted to VitePress home layout with hero section and features |
| docs/**/*.md | Converted admonitions to VitePress containers and tabs to code groups |
| docs/examples/Sudoku.vue | Updated to work with VitePress (changed rule URL path, added biome-ignore comments) |
| docs/public/examples/Sudoku.ejs | New EJS template for Sudoku rules |
| .gitignore | Updated from site/ to .vitepress/dist and .vitepress/cache |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
hzhangxyz
force-pushed
the
dev/vitepress
branch
from
January 1, 2026 10:36
4f91e2e to
0e4ada9
Compare
hzhangxyz
force-pushed
the
dev/vitepress
branch
from
January 1, 2026 10:39
0e4ada9 to
accfe9d
Compare
- Updated feature descriptions for a more neutral and accurate tone. - Ensured consistency between README.md and documentation home page. - Removed deprecated 'apyds.__version__' access from examples. - Updated API Reference quick link to point to TypeScript documentation.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 16 out of 20 changed files in this pull request and generated no new comments.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
This PR migrates the project's documentation system from MkDocs to VitePress to improve performance, maintainability, and leverage Vue.js for interactive examples.
Key Changes:
System Migration:
Content Refactoring:
Interactive Examples:
API Documentation:
Cleanup: