Skip to content

Conversation

@hzhangxyz
Copy link
Member

@hzhangxyz hzhangxyz commented Jan 1, 2026

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:

  1. System Migration:

    • Replaced MkDocs (mkdocs.yml) with VitePress (.vitepress/config.mts).
    • Updated project dependencies (package.json, pyproject.toml) to include VitePress and remove MkDocs.
    • Configured VitePress with local search, math support (markdown-it-mathjax3), and proper build targets for Wasm.
  2. Content Refactoring:

    • Converted all Markdown files from MkDocs-specific syntax (admonitions, tabbed code blocks) to VitePress-native containers (::: tip, ::: code-group).
    • Refined the Home page (index.md) and README.md to feature a more neutral tone and accurate feature list.
    • Cleaned up redundant "See Also" and "Next Steps" sections for a cleaner navigation flow.
  3. Interactive Examples:

    • Refactored the Sudoku example to be a native Vue component (Sudoku.vue) integrated directly into the documentation.
    • Ensured proper loading of Wasm modules (atsds) within the VitePress build environment.
  4. API Documentation:

    • Updated API references and ensured links point to the correct TypeScript/Python/C++ documentation.
    • Fixed formatting issues in support package documentation (egg.md, bnf.md).
  5. Cleanup:

    • Removed apyds.version from examples to align with best practices.
    • Updated .gitignore to track VitePress build artifacts.

- 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.
Copilot AI review requested due to automatic review settings January 1, 2026 10:29
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 hzhangxyz changed the title docs: migrate from MkDocs to VitePress docs: Migrate Documentation System from MkDocs to VitePress Jan 1, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@hzhangxyz hzhangxyz merged commit 2590c1f into main Jan 1, 2026
98 of 99 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants