Skip to content

Conversation

@wuqunfei
Copy link
Contributor

Summary

This PR migrates the MkDocs documentation configuration from the Material theme to the ReadTheDocs theme, simplifying the theme setup and reducing configuration complexity.

Key Changes

  • Theme Migration: Changed from material theme to readthedocs theme
  • Removed Material-specific features: Eliminated Material palette configuration (light/dark mode toggle), navigation features (instant loading, tracking, sections, expand), and search enhancements
  • Simplified syntax highlighting: Replaced pymdownx.highlight with codehilite extension and configured language support for Python, Rust, Bash, and JSON
  • Removed Material extensions: Eliminated pymdownx.inlinehilite, pymdownx.tabbed, pymdownx.details, and Material-specific icon configurations
  • Cleaned up social links: Removed GitHub social link from extra configuration
  • Reorganized markdown extensions: Reordered extensions for clarity, keeping only essential ones (admonition, codehilite, toc, tables, attr_list, md_in_html, pymdownx.superfences, pymdownx.snippets)

Notable Details

  • The ReadTheDocs theme provides a more lightweight, documentation-focused experience
  • Language-specific syntax highlighting is now explicitly configured rather than auto-detected
  • The version provider (mike) configuration is preserved for version management
  • All core documentation functionality is maintained while reducing configuration overhead

Switch MkDocs theme from material to readthedocs while keeping
Markdown format. Simplified markdown extensions for compatibility.

https://claude.ai/code/session_019ESfggeFxww3YVHk4EKe1i
@wuqunfei wuqunfei merged commit c9df32d into feature/application-clean-version Jan 26, 2026
3 of 16 checks passed
@wuqunfei wuqunfei deleted the claude/update-docs-theme-Z9cKY branch January 27, 2026 00:26
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.

3 participants