-
Notifications
You must be signed in to change notification settings - Fork 298
docs: format code snippets in markdown files #1324
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: format code snippets in markdown files #1324
Conversation
83c8652
to
8189af0
Compare
You can also add the mdsf GHA action that @housegen added recently to mdsf |
61fd240
to
3d7458b
Compare
Added using the manual from https://mdsf.mhouge.dk/#github-action |
I'm tired … and sorry. Everything is fine. I through I had read the mdsf was installed via cargo 🤦♂️ |
Is there anything blocking you @alexandear ? |
Yes. I'm thinking about formatting .sh and .toml files and need to find a suitable formatter. |
Most of them are listed on mdsf pages sh: shfmt |
4f03273
to
8d15990
Compare
c3276c0
to
1fe8119
Compare
8320552
to
4e56d92
Compare
4e56d92
to
d1d5ea4
Compare
The PR fixes the formatting of code blocks in all Markdown files.md. It also adds
mdsf
to lint formatting in CI.The following formatters were chosen:
go
sh
,bash
,shell
toml
Caveats and Workarounds
Some Go code snippets can't be formatted with
goimports
. I marked them withgolang
- this way, GitHub displays them as Go code, butmdsf
will skip them. The similar forshellsession
-shfmt
can't format it, so I disabled.Updates #1350