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

Fix 2 issues in MD #37

Merged
merged 2 commits into from
Jan 20, 2024
Merged

Fix 2 issues in MD #37

merged 2 commits into from
Jan 20, 2024

Conversation

pierre-24
Copy link
Contributor

  1. In latter version of mkdocs-material, material.extensions should be used instead of materialx (there is a warning at build time)
  2. The --- after the generator: doxide gets interpreted and results in a useless <hr> at the top of every page ;)

@lawmurray lawmurray merged commit 0986474 into lawmurray:main Jan 20, 2024
@lawmurray
Copy link
Owner

Thanks for this one @pierre-24, merged.

Incidentally, the material.extensions vs materialx I've been going back and forth on, as the older version of mkdocs-material is available in some Linux distributions (e.g. Ubuntu 23.10) and users may like to install it from there rather than pip. Not sure that there's a great resolution to this, except that people will slowly migrate to the newer version, and can always edit their mkdocs.yaml file for what they have installed.

@pierre-24 pierre-24 deleted the fix_md_issues branch January 20, 2024 16:45
@pierre-24
Copy link
Contributor Author

Ok, I see. One way to help in this matter is to add that to the documentation :)

@pierre-24
Copy link
Contributor Author

pierre-24 commented Jan 20, 2024

Whoops, I made your CI fail on exactlty that issue, sorry about that.

By the way, I think there is a way for your CI to run on PR as well and prevent PR to be merged if test fails. See there (I don't know CircleCI, but this looks like it).
Then, you "just" need to create branch protection rules and especially check the " Require status checks to pass before merging" option :)

@lawmurray
Copy link
Owner

Yes, requires some work, will get there eventually.

I've had to revert the --- change in 6afdfd3 unfortunately, turns out it breaks doxide clean. Will have to find another workaround to avoid the <hr>.

@lawmurray
Copy link
Owner

lawmurray commented Jan 20, 2024

Fixed in 7d308b1. MkDocs seems to want the frontmatter to both start and end with --- to not insert the <hr>. A few updates were required to Doxide's parsing of YAML frontmatter accordingly.

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