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

chore(docs): disable markdown macro rendering for source file pages #225

Merged
merged 1 commit into from
Nov 12, 2024

Conversation

mojomex
Copy link
Collaborator

@mojomex mojomex commented Nov 12, 2024

PR Type

  • Improvement

Description

Some valid C++ sequences, such as {{{, overlap with the Jinja2 syntax and cause MkDocs errors. This PR disables the macros MkDocs plugin for all *_source.md files.

Pre-Review Checklist for the PR Author

PR Author should check the checkboxes below when creating the PR.

  • Assign PR to reviewer

Checklist for the PR Reviewer

Reviewers should check the checkboxes below before approval.

  • Commits are properly organized and messages are according to the guideline
  • (Optional) Unit tests have been written for new behavior
  • PR title describes the changes

Post-Review Checklist for the PR Author

PR Author should check the checkboxes below before merging.

  • All open points are addressed and tracked via issues or tickets

CI Checks

  • Build and test for PR: Required to pass before the merge.

Some valid C++ sequences, such as `{{{`, overlap with the Jinja2 syntax and cause MkDocs errors.

Signed-off-by: Max SCHMELLER <[email protected]>
@mojomex mojomex merged commit 3284357 into main Nov 12, 2024
8 of 9 checks passed
@mojomex mojomex deleted the fix/ars548-docs-rendering branch November 12, 2024 09:08
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