pradyunsg / furo

A clean customizable documentation theme for Sphinx
https://pradyunsg.me/furo/quickstart
MIT License
2.69k stars 309 forks source link

Broken link in Markup Reference->Code Blocks #593

Closed pradyunsg closed 1 year ago

pradyunsg commented 1 year ago

Discussed in https://github.com/pradyunsg/furo/discussions/591

Originally posted by **ivergara** December 7, 2022 In the [documentation](https://pradyunsg.me/furo/reference/code-blocks/) concerning code blocks, the link at the end pointing to https://myst-parser.readthedocs.io/en/latest/using/intro.html#block-level-directives-with-myst-markdown is broken as in that anchor doesn't exist.

What's broken?

https://pradyunsg.me/furo/reference/code-blocks/ has a broken link, pointing to https://myst-parser.readthedocs.io/en/latest/using/intro.html#block-level-directives-with-myst-markdown

What's the fix?

Fixing the broken link, by pointing to the relevant location in myst-parser's documentation about block level directives. It's likely moved as part of a documentation update.

DiddiLeija commented 1 year ago

Hi!

Does https://myst-parser.readthedocs.io/en/latest/intro.html#extend-commonmark-with-roles-and-directives cover what is needed? Or probably https://myst-parser.readthedocs.io/en/latest/syntax/roles-and-directives.html?

pradyunsg commented 1 year ago

The later seems like a better fit, since it's less in-the-flow for some other content and covers what we want at the start! :)

DiddiLeija commented 1 year ago

Oh, nice! I'll come back with the fix ;)

DiddiLeija commented 1 year ago

Done! #595