Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Potential Maintenance Challenges with Locked mkdocs-material Version #26

Open
PierreDillard opened this issue Nov 13, 2024 · 1 comment

Comments

@PierreDillard
Copy link
Contributor

Description:
The current setup locks the site to mkdocs-material version 9.5.44, implemented to prevent layout issues during automatic deployments after each commit to the master branch. While this solution is effective for now, it may lead to maintenance challenges in the future as mkdocs-material evolves.

Background:

  • Recent modifications in base.html directly impact the foundational files of mkdocs-material, including CSS and JavaScript, which are hashed and minified during each release.
  • Since mkdocs-material’s release process can alter file hashes, the current configuration may require manual updates to these references in the future.
@nlsdvl
Copy link
Collaborator

nlsdvl commented Nov 13, 2024

@PierreDillard - Locking the version is required not just for deployment, but also for any fresh local dev installation.

Indeed, the challenge comes from the modifications made to base.html.

Ways to deal with this situation include forking of mkdocs-material, or refactoring to avoid making changes to base.html.

Whenever updating the base.html file, the mkdocs-material version from which is was taken must be reflected in the README.md and in the automatic deployment workflow.

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

No branches or pull requests

2 participants