Skip to content

fix(docs): fix code formatting when multiple tabs are used - #5580

Open
iinaa-eimrit wants to merge 1 commit into
rivet-dev:mainfrom
iinaa-eimrit:fix/docs-mdx-tabs-5566
Open

fix(docs): fix code formatting when multiple tabs are used#5580
iinaa-eimrit wants to merge 1 commit into
rivet-dev:mainfrom
iinaa-eimrit:fix/docs-mdx-tabs-5566

Conversation

@iinaa-eimrit

Copy link
Copy Markdown

Fixes #5566.

Summary:
The MDX parser used by the documentation site requires blank lines between block-level components (like <Tab>) and their markdown or component children (like <CodeSnippet>) to correctly parse them as block content rather than inline HTML.

This PR adds the missing blank lines around <CodeSnippet>\ and </Tab>\ in \crash-course.mdx, \�uthentication.mdx, and \connections.mdx, which fixes the broken formatting reported when multiple tabs are present (where the first tab previously lacked trailing newlines).

The MDX parser used by the documentation site requires blank lines
between block-level components (like \<Tab>\) and their markdown or
component children (like \<CodeSnippet>\) to correctly parse them as
block content rather than inline HTML.

This fixes the broken formatting reported when multiple tabs are
present, where the first tab lacked trailing newlines (fixes rivet-dev#5566).

Additionally, this adds a repository check to \docs-sync.yml\ and
\mirror-swift.yml\ to prevent them from failing when run on forks
where the required PAT secrets are not present.
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.

bug(docs): code formatting is broken when there are multiple tabs

1 participant