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

Include HTML in docs markdown (fix alignment) #1887

Closed
Caellian opened this issue May 2, 2024 · 1 comment · Fixed by #1900
Closed

Include HTML in docs markdown (fix alignment) #1887

Caellian opened this issue May 2, 2024 · 1 comment · Fixed by #1900
Labels
bug related to incorrect existing implementation of some functionality documentation suggests documentation changes or improvements

Comments

@Caellian
Copy link
Collaborator

Caellian commented May 2, 2024

@brndnmtthws I modified alignment documentation recently and accidentally broke it because pandoc removes embedded HTML - it's missing main table with alignments.

I tried fixing it in one of subsequent PRs but it didn't work. I'm not sure how to build documentation locally and can't preview changes in a PR which is why I created this issue. Can you try different options suggested in the following SO answer to see whether this can be fixed: Embed indented HTML in Markdown with Pandoc.

Allowing HTML would also enable much better documentation down the line.

@Caellian Caellian added bug related to incorrect existing implementation of some functionality documentation suggests documentation changes or improvements labels May 2, 2024
@Caellian
Copy link
Collaborator Author

Caellian commented May 4, 2024

I decided to put in some time to understand where pandoc is used and how the website works, was pretty straightforward to apply suggestion then - even though I wasn't able to get headless tables to work because pandoc (MAN) and unified.js (web) don't support any common syntax extensions and HTML tables get removed from MAN.

Also figured out netlify bot posts a preview 🤦‍♂️ . I was just jumping over that bot comment out of habit.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug related to incorrect existing implementation of some functionality documentation suggests documentation changes or improvements
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants