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 capitalization in nav sidebar and fix pymdownx.snippets section magic left in rendered text #537

Merged
merged 2 commits into from
Nov 8, 2024

Conversation

felker
Copy link
Member

@felker felker commented Nov 8, 2024

#492 and #502 nicely started using pymdownx.snippets sections for the first time in this repo (#492 (review)). While the section is correctly included in the destination file (e.g. https://docs.alcf.anl.gov/sophia/containers/containers/#recipe-based-container-building), the source file erroneously still keeps in the --8<-- preprocessing magic
image

@felker
Copy link
Member Author

felker commented Nov 8, 2024

The extension documentation wording was ambiguous here, but I figured out that you need to wrap the section start/end magics in HTML comments if the section source is Markdown, analogous to the Python source example they show in https://facelessuser.github.io/pymdown-extensions/extensions/snippets/#snippet-sections

<!-- --8<-- [start:commoncontainerdoc] -->

@felker felker marked this pull request as ready for review November 8, 2024 04:21
@felker felker merged commit a680538 into main Nov 8, 2024
1 check passed
@felker felker deleted the hotfix/snippets-and-nav branch November 8, 2024 04:21
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