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

docs: Fix small formatting errors #7700

Merged
merged 2 commits into from
Feb 7, 2023
Merged

Conversation

iFreilicht
Copy link
Contributor

The MD preview on GitHub is incorrectly formatting the || operator as part of the table. mdbook correctly interprets this as code.

Motivation

Small formatting errors. See screenshots below.
Screenshot 2023-01-26 at 22 52 30
Screenshot 2023-01-26 at 22 52 57

Context

Trivial docs change.

Checklist for maintainers

Maintainers: tick if completed or explain if not relevant

  • agreed on idea
  • agreed on implementation strategy
  • tests, as appropriate
    • functional tests - tests/**.sh
    • unit tests - src/*/tests
    • integration tests
  • documentation in the manual
  • code and comments are self-explanatory
  • commit message explains why the change was made
  • new feature or bug fix: updated release notes

@abathur
Copy link
Member

abathur commented Jan 26, 2023

This appears to basically revert #7638, which makes me think the renderers may be disagreeing?

@iFreilicht
Copy link
Contributor Author

That is indeed the case. Actually, it seems to be a bug in mdbook's dependency pulldown-cmark since 2019. I opened a bug report with mdbook linking the pulldown-cmark issue.

I reverted that line, so this PR now only contains the fix for the anchor link and removal of a trailing whitespace.

@iFreilicht
Copy link
Contributor Author

Ha, so in the mdBook issue a workaround was mentioned using <code> tags instead of backticks, and that actually works! I added that fix, built it with mdbook locally, and it works! So now the PR would be ready to merge, @fricklerhandwerk :)

@fricklerhandwerk
Copy link
Contributor

Looks good, thanks a lot!

@fricklerhandwerk fricklerhandwerk merged commit c192151 into NixOS:master Feb 7, 2023
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.

3 participants