fix(docs): render LaTeX formulas and fix build warnings#60
Merged
Conversation
Add MathJax configuration script required by pymdownx.arithmatex generic mode. The config must load before MathJax to register the custom delimiters and arithmatex CSS class. Also fix unrecognized relative link warning for reference/ in index.md. Closes #59 Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
Updates the MkDocs documentation build so LaTeX math renders correctly under pymdownx.arithmatex generic mode and eliminates a strict-build warning from an invalid relative link.
Changes:
- Add a MathJax configuration script (
docs/javascripts/mathjax.js) to enablearithmatexgeneric-mode rendering and re-typeset on instant navigation. - Ensure the MathJax config loads before the MathJax library in
mkdocs.yml. - Fix the docs homepage “API Reference” link to point to
reference/index.mdto avoid build warnings.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| mkdocs.yml | Loads the MathJax config script before MathJax to support arithmatex generic mode. |
| docs/javascripts/mathjax.js | Introduces MathJax config + document$ hook to re-typeset formulas on navigation. |
| docs/index.md | Replaces reference/ with reference/index.md to satisfy strict link checking. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
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.
Summary
docs/javascripts/mathjax.jsconfig required bypymdownx.arithmatexgeneric mode to register\(...\)/\[...\]delimiters and thearithmatexCSS classmkdocs.ymlreference/inindex.mdTest plan
uv run mkdocs build --strict— no warningsCloses #59
🤖 Generated with Claude Code