search

FabricMC / fabric-docs

[WIP] Official curated documentation for Fabric, a modding toolchain for Minecraft.
https://docs.fabricmc.net
Other
39 stars 39 forks source link

Lint Markdown files, fix headings style #99

Closed its-miroma closed 1 month ago

its-miroma commented 1 month ago

Linting

Headings

Other

netlify[bot] commented 1 month ago

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.

IMB11 commented 1 month ago

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:

its-miroma commented 1 month ago

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 commented 1 month ago

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

its-miroma commented 1 month ago

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