Skip to content

fix(docs): render Material icons via pymdownx.emoji#57

Merged
amcheste merged 1 commit into
developfrom
fix/docs-material-icons
Jun 5, 2026
Merged

fix(docs): render Material icons via pymdownx.emoji#57
amcheste merged 1 commit into
developfrom
fix/docs-material-icons

Conversation

@amcheste-ai-agent
Copy link
Copy Markdown
Contributor

Summary

The deployed docs site's "Where to go from here" cards on the home page show literal :material-rocket-launch:{ .lg .middle } text instead of the intended Material icons. mkdocs.yml is missing the pymdownx.emoji extension that resolves Material icon shortcodes — this PR adds the standard Material for MkDocs emoji config so :material-*: shortcodes turn into inline SVG icons.

See: https://amcheste.github.io/overleaf-mcp/ (cards under "Where to go from here").

How to deploy this fix

(Two options — pick whichever's easier; both end with the docs site rendering icons.)

Option A — fastest (docs deploy from develop directly):

gh workflow run docs.yml --ref develop

Pages env permits develop already (we added it). One command, one deploy.

Option B — conventional (promote develop→main, docs.yml fires on push):

# develop→main promotion PR can be opened on request; or CLI if main push isn't blocked

After deploy

  • Hard-refresh https://amcheste.github.io/overleaf-mcp/ and confirm the four cards under "Where to go from here" render with rocket / toolbox / server-network / shield-check icons.
  • After this and the v0.4.1 GitHub release land, the docs site's version badge will also update from v0.3.0v0.4.1 (badge is a runtime API fetch).

🤖 Generated with Claude Code

The docs site's "Where to go from here" cards on the home page render
literal `:material-rocket-launch:{ .lg .middle }` text instead of the
intended Material Design icons, because mkdocs.yml is missing the
`pymdownx.emoji` extension that resolves Material icon shortcodes.

Add the standard Material for MkDocs emoji config so `:material-*:`
shortcodes turn into inline SVG icons.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: amcheste <13696614+amcheste@users.noreply.github.com>
@amcheste-ai-agent amcheste-ai-agent Bot requested a review from amcheste as a code owner June 4, 2026 17:04
@amcheste amcheste merged commit f1f0ae9 into develop Jun 5, 2026
15 checks passed
@amcheste amcheste deleted the fix/docs-material-icons branch June 5, 2026 11:33
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