maintenance(docs): Switch docs formatter from Prettier to customized remark-stringify

Description

Switch the docs formatter from prettier to remark-stringify, customized with additional rules.

Motivation

remark-stringify is extensible and allows users and plugins to extend the compiler with changes. We need this flexibility to do things such as auto-generating heading IDs to docs (#20732).

Issues

The default remark-stringify won’t work for a variety of issues (even with configurations). These can be seen in this diff: https://github.com/gatsbyjs/gatsby/compare/remark-stringify?expand=1

• Doesn’t understand codeblock titles generated with gatsby-remark-code-titles: it escapes the underscores in the title and parses the title as part of the language block.
• Adds <> to URLs (e.g. https://youtube.com becomes <https://youtube.com>). (I think) This interferes with gatsby-remark-embedder, which requires the raw URLs to embed Youtube and Giphy links.
• Doesn’t support code formatting in links (it escapes tildes)

Minor difference from Prettier:

• Doesn’t escape dollar signs ($) unless the latex plugin is installed.
• Adds line breaks between link definitions
• Some weird table formatting?

[tesseralis]

@capndave

1. Correct, we only want to run remark-stringify on markdown files in the docs dir
2. We’re using remark to lint the docs but prettier to format them
3. Remark-stringify should be used in in the lint-staged command. A new format:docs command should be added that runs remark-stringify on the docs, and it should be added to the format script.

[github-actions[bot]]

Hiya!

This issue has gone quiet. Spooky quiet. 👻

We get a lot of issues, so we currently close issues after 60 days of inactivity. It’s been at least 20 days since the last update here. If we missed this issue or if you want to keep it open, please reply here. As a friendly reminder: the best way to see this issue, or any other, fixed is to open a Pull Request. Check out gatsby.dev/contribute for more information about opening PRs, triaging issues, and contributing!

Thanks for being a part of the Gatsby community! 💪💜