Skip to content

Comments

doc: escape tags in markdown in prepration for docusaurus2#14379

Merged
techdocsmith merged 3 commits intoapache:masterfrom
317brian:fix-markdown-syntax
Jun 8, 2023
Merged

doc: escape tags in markdown in prepration for docusaurus2#14379
techdocsmith merged 3 commits intoapache:masterfrom
317brian:fix-markdown-syntax

Conversation

@317brian
Copy link
Contributor

@317brian 317brian commented Jun 6, 2023

Docusaurus2 is stricter when it comes to syntax. The site will not render unless these are escaped.

The \ does not render as expected in the output:

image

Also updates to be markdown syntax instead:
https://druid-lybon0ab4-317brian.vercel.app/docs/design/architecture.html
image

This PR has:

  • been self-reviewed.

Co-authored-by: Victoria Lim <vtlim@users.noreply.github.com>
Copy link
Contributor

@techdocsmith techdocsmith left a comment

Choose a reason for hiding this comment

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

LGTM

@techdocsmith techdocsmith merged commit ff577a6 into apache:master Jun 8, 2023
@abhishekagarwal87 abhishekagarwal87 added this to the 27.0 milestone Jul 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants