Skip to content

feat: MkDocs config improvements#37

Open
bakerboy448 wants to merge 6 commits intoNotifiarr:mainfrom
bakerboy448:feat/mkdocs-improvements
Open

feat: MkDocs config improvements#37
bakerboy448 wants to merge 6 commits intoNotifiarr:mainfrom
bakerboy448:feat/mkdocs-improvements

Conversation

@bakerboy448
Copy link
Copy Markdown
Collaborator

@bakerboy448 bakerboy448 commented Mar 12, 2026

Summary

  • Add navigation.instant.prefetch and navigation.instant.progress for faster perceived navigation
  • Add pymdownx.highlight (with anchor line numbers) and pymdownx.inlinehilite for syntax highlighting in code blocks
  • Fix toc.permalink from empty string to true for standard permalink behavior
  • Add mkdocs-minify-plugin to minify HTML/JS/CSS output for faster page loads
  • Move search plugin before glightbox for correct plugin load order
  • Enable --strict mode in both CI build and deploy workflows to catch warnings as errors
  • Add site/ to .gitignore

Test plan

  • Local mkdocs build --strict passes
  • N/A CI build workflow passes on PR

Add pymdownx.highlight with anchor line numbers and
pymdownx.inlinehilite for inline code highlighting.
Minifies HTML, JS, and CSS in built output for faster page loads.
Moves search plugin before glightbox for correct load order.
Comment thread mkdocs.yml
- toc:
toc_depth: 4
permalink: ''
permalink: true
Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Unless there was a reason?

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.

1 participant