Skip to content

docs: removed some markdownlint rules #5615

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.

Sign up for GitHub

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

Merged
jdx merged 2 commits into from
Jul 13, 2025
Merged

docs: removed some markdownlint rules #5615

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3571c91
docs: removed some markdownlint rules
jdx Jul 13, 2025
b61e87d
[autofix.ci] apply automated fixes
autofix-ci[bot] Jul 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .markdownlint.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
{
"MD004": false,
"MD013": false,
"MD022": false,

Copilot AI Jul 13, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding a comment explaining why MD022 (headings should be surrounded by blank lines) is disabled, as this affects document readability.

Copilot uses AI. Check for mistakes.
"MD029": false,
"MD031": false,

Copilot AI Jul 13, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding a comment explaining why MD031 (fenced code blocks should be surrounded by blank lines) is disabled, as this affects code block readability in documentation.

Copilot uses AI. Check for mistakes.
"MD032": false,

Copilot AI Jul 13, 2025

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] Consider adding a comment explaining why MD032 (lists should be surrounded by blank lines) is disabled, as this affects list formatting consistency in documentation.

Copilot uses AI. Check for mistakes.
"MD033": false,
"MD040": false,
"MD041": false
Expand Down
1 change: 0 additions & 1 deletion docs/cli/settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,6 @@ Output in TOML format
- [`mise settings unset [-l --local] <KEY>`](/cli/settings/unset.md)

Examples:

```
# list all settings
$ mise settings
Expand Down
1 change: 0 additions & 1 deletion docs/cli/trust.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ This means mise will parse the file with potentially dangerous
features enabled.

This includes:

- environment variables
- templates
- `path:` plugin versions
Expand Down
1 change: 0 additions & 1 deletion docs/cli/unuse.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ Removes installed tool versions from mise.toml
By default, this will use the `mise.toml` file that has the tool defined.

In the following order:

- If `--global` is set, it will use the global config file.
- If `--path` is set, it will use the config file at the given path.
- If `--env` is set, it will use `mise.<env>.toml`.
Expand Down
2 changes: 0 additions & 2 deletions docs/cli/use.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ This will install the tool version if it is not already installed.
By default, this will use a `mise.toml` file in the current directory.

In the following order:

- If `--global` is set, it will use the global config file.
- If `--path` is set, it will use the config file at the given path.
- If `--env` is set, it will use `mise.<env>.toml`.
Expand Down Expand Up @@ -85,7 +84,6 @@ Consider using mise.lock as a better alternative to pinning in mise.toml:
<https://mise.jdx.dev/configuration/settings.html#lockfile>

Examples:

```

# run with no arguments to use the interactive selector
Expand Down
Loading