interface-spec icon indicating copy to clipboard operation
interface-spec copied to clipboard

chore: update markdown formatting for v3 mdx parser

Open dfx-json opened this issue 10 months ago • 3 comments

The portal will soon be upgraded to Docusaurus v3. In order to successfully compile, submodules must conform to mdx v3 parsing rules.

This PR updates the formatting to use backticks whenever possible, and escapes { with a backslash.

dfx-json avatar Mar 30 '24 02:03 dfx-json

🤖 Here's your preview: https://p3j7v-5yaaa-aaaak-qckka-cai.icp0.io/docs

github-actions[bot] avatar Mar 30 '24 02:03 github-actions[bot]

Could you please also add a CI check for the new formatting? Otherwise, we're likely to deviate again pretty soon.

mraszyk avatar Apr 04 '24 06:04 mraszyk

@mraszyk would upgrading the docusaurus version (see https://github.com/dfinity/interface-spec/pull/297) used in the interface-spec repo suffice? It's not clear to me what CI checks could be added to enforce proper formatting.

dfx-json avatar Apr 08 '24 21:04 dfx-json

closing in favor of pursuing #297

dfx-json avatar Jun 19 '24 00:06 dfx-json