Skip to content
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

Use MarkdownLint to correct irregular Markdown writing in documents #225

Closed
normal-coder opened this issue Aug 21, 2023 · 1 comment · Fixed by #219
Closed

Use MarkdownLint to correct irregular Markdown writing in documents #225

normal-coder opened this issue Aug 21, 2023 · 1 comment · Fixed by #219
Labels
enhancement New feature or request

Comments

@normal-coder
Copy link
Contributor

Description

Due to the flexibility of Markdown, its writing may not work well in various parsers due to its structure, which is why document projects need to use MarkdownLint reason.

When I tried to check it with markdownlint-cli, there are many places that need to be changed. After ignoring the single line length (MD013) rule, there are still 444 places that need to be considered for modification.

image

Perhaps some rules are not very important, but it is indeed a delicate work that needs to be checked item by item to ensure the accuracy of the document content.

By creating this Issue, I hope to gradually correct the non-standard Markdown in the Docs warehouse, and link to this Issue when submitting a Pull Request.

From the perspective of an active external contributor, ensuring that each Pull Request is complete, simple, and readable, I think this is a friendly performance of the Maintainer.

Hope that those who intend to participate in this action can keep your changes as "readable" and "maintainable" as possible, instead of changing dozens of documents in one brain.

While this makes these pull requests look "less high quality", it is necessary. This will help you and the Maintainer move the documentation forward faster.

@normal-coder normal-coder added the enhancement New feature or request label Aug 21, 2023
@normal-coder
Copy link
Contributor Author

Try to fix the irregular writing in the Logging related documents through #219.

normal-coder added a commit to normal-coder/Sigstore-Docs that referenced this issue Aug 25, 2023
…onsole` with `bash`

Resolves sigstore#225

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>
ltagliaferri pushed a commit that referenced this issue Aug 25, 2023
* docs(specification):  improve logging documentation following MD014

Specification reference: https://github.com/DavidAnson/markdownlint/

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>

* docs(lint): follow `MD009` and `MD014` to improve docs and replace `console` with `bash`

Resolves #225

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>

---------

Signed-off-by: 诺墨 <zhangshengxiang@gitee.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant