Skip to content

Set the experimental document attribute to enable the keyboard macro #191

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

Merged
merged 1 commit into from
Dec 14, 2022

Conversation

noritada
Copy link
Contributor

I found that HTML outputs of some changelog posts such as Changelog #11 contains raw keyboard macro expressions such as kbd:[Enter].
This PR sets the experimental document attribute on those posts to make the macro processed.

I think it would be nice if the changelog draft has that attribute by default, so I will post a separate PR to change the draft generated by xtask release.

noritada added a commit to noritada/rust-analyzer that referenced this pull request Dec 14, 2022
…d draft changelog

The keyboard macro (`kbd:[...]`) requires this attribute.

This default change will prevent issues like
rust-analyzer/rust-analyzer.github.io#191 .
@lnicola
Copy link
Member

lnicola commented Dec 14, 2022

Ref. https://docs.asciidoctor.org/asciidoc/latest/macros/keyboard-macro/

I thought this might not be needed in a more recent version of AsciiDoc, but that doesn't seem to be the case.

Thanks!

@lnicola lnicola merged commit 4cc4dd7 into rust-analyzer:src Dec 14, 2022
@lnicola
Copy link
Member

lnicola commented Dec 14, 2022

Confirmed to work:

image

bors added a commit to rust-lang/rust-analyzer that referenced this pull request Dec 14, 2022
…log-draft, r=lnicola

minor: Set the `experimental` AsciiDoc document attribute to generated draft changelog

This PR sets the `experimental` AsciiDoc document attribute to generated draft changelog.

That attribute is required by the keyboard macro (`kbd:[...]`).
This change of the draft will prevent issues like rust-analyzer/rust-analyzer.github.io#191 .
lnicola added a commit that referenced this pull request Jul 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants