fabric-docs icon indicating copy to clipboard operation
fabric-docs copied to clipboard

Lint Markdown files, fix headings style

Open its-miroma opened this issue 1 year ago • 5 comments

Linting

  • Remove trailing whitespace
  • Single newline at the end of each file
  • Remove unnecessary quotes in frontmatters
  • Use relative link for CONTRIBUTING.md
  • Update sidebar_translations.json
  • Increment headings one level at a time
  • Remove punctuation from headings, except exclamation marks

Headings

Other

  • Capitalize various instances of "Java", "Loader", "Loom"
  • Add custom heading link in codecs.md
  • Avoid using emphasis for headings in effects.md
    • Side Effect: the auto-generated TOC now shows those two headings
  • Change info box in potions.md (may fix #89)
  • Add alt text to image in hud.md
  • Avoid using invisible spaces for a line break in creating-particles.md
  • Capitalize alt texts in custom.md

its-miroma avatar May 11 '24 14:05 its-miroma

Deploy Preview for nimble-elf-d9d491 ready!

Name Link
Latest commit 82dd085a993bd46c9859a99a465c1636c6a91a58
Latest deploy log https://app.netlify.com/sites/nimble-elf-d9d491/deploys/6641d335187acd00089dabc8
Deploy Preview https://deploy-preview-99--nimble-elf-d9d491.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar May 11 '24 14:05 netlify[bot]

Maybe it's worth integrating a markdown lint action/tool - I didn't originally suggest one because to be frank they all suck. There isn't really any good linters out there that:

  • Automatic fix markdown issues using a CLI command.
  • Aren't annoying to configure and understand lint errors.

IMB11 avatar May 11 '24 15:05 IMB11

I personally use markdownlint by David Anson, which has a VS Code extension and a cli.

It works pretty well and supports custom rules; there probably are some for Title Case as well.

Its rules are pretty strict, I'd recommend disabling MD025 and MD026 (with punctuation: ".,;:。,;:").

its-miroma avatar May 11 '24 15:05 its-miroma

There even is a GitHub Action, although I have to admit I'm not super familiar with that

its-miroma avatar May 11 '24 16:05 its-miroma

I personally use markdownlint by David Anson, which has a VS Code extension and a cli.

There even is a GitHub Action, although I have to admit I'm not super familiar with that

Please review #101

its-miroma avatar May 12 '24 18:05 its-miroma