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 anchor generation in website partials #223

Merged
merged 1 commit into from
Mar 21, 2024

Conversation

JanMa
Copy link
Member

@JanMa JanMa commented Mar 19, 2024

We use a custom plugin from upstream to include partials in our MDX docs
which can also contain MDX syntax that needs to be evaluated. The
inclusion needs to happen before the default docusaurus remark plugins
run for them to be able to properly evaluate the contained MDX syntax.

One example where this currently does not work is when we overwrite the
generated anchors of a heading.

Current status:
image

Fixed status:
image

Copy link
Member

@cipherboy cipherboy left a comment

Choose a reason for hiding this comment

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

Assuming I'm looking at the right page (/docs/internals/telemetry/metrics/authn/#vault-expire-revoke) I think this looks good!

@JanMa
Copy link
Member Author

JanMa commented Mar 20, 2024

Assuming I'm looking at the right page (/docs/internals/telemetry/metrics/authn/#vault-expire-revoke) I think this looks good!

I've added some screenshots to the PR body to show the difference

We use a custom plugin from upstream to include partials in our MDX docs
which can also contain MDX syntax that needs to be evaluated. The
inclusion needs to happen before the default docusaurus remark plugins
run for them to be able to properly evaluate the contained MDX syntax.

One example where this currently does not work is when we overwrite the
generated anchors of a heading.

Signed-off-by: Jan Martens <jan@martens.eu.org>
@naphelps naphelps added this pull request to the merge queue Mar 21, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to no response for status checks Mar 21, 2024
@naphelps naphelps merged commit 7f07a7e into openbao:main Mar 21, 2024
21 of 23 checks passed
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.

None yet

3 participants