Skip to content

docs: switch from Jekyll to Material for MkDocs#17

Merged
kulvirgit merged 1 commit intomainfrom
docs/switch-to-mkdocs-material
Mar 2, 2026
Merged

docs: switch from Jekyll to Material for MkDocs#17
kulvirgit merged 1 commit intomainfrom
docs/switch-to-mkdocs-material

Conversation

@anandgupta42
Copy link
Contributor

Summary

  • Replace Jekyll + just-the-docs with Material for MkDocs to match the brand style on docs.myaltimate.com
  • Light/dark toggle with matching color scheme (default/slate, white/black primary, blue accent)
  • Download logo and favicon from docs.myaltimate.com
  • Restructure docs/ to MkDocs layout (docs/mkdocs.yml + docs/docs/ content directory)
  • Strip Jekyll frontmatter and convert callouts to MkDocs admonitions
  • Update GitHub Actions workflow to build with mkdocs build instead of Jekyll

Test plan

  • cd docs && pip install mkdocs-material && mkdocs serve — preview locally
  • Confirm light/dark mode toggle matches docs.myaltimate.com
  • Confirm navigation structure preserved (Tools, Guides sections)
  • Push to main → verify GitHub Pages deployment succeeds

🤖 Generated with Claude Code

Replace Jekyll + just-the-docs with Material for MkDocs to match
the brand style on docs.myaltimate.com (light/dark toggle, color
scheme, logo, and favicon).

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@anandgupta42 anandgupta42 requested a review from kulvirgit March 2, 2026 23:07
@kulvirgit kulvirgit merged commit c5a5be8 into main Mar 2, 2026
0 of 4 checks passed
@kulvirgit kulvirgit deleted the docs/switch-to-mkdocs-material branch March 10, 2026 21:07
anandgupta42 pushed a commit that referenced this pull request Mar 17, 2026
docs: switch from Jekyll to Material for MkDocs
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