You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@graphar.apache.org by "ywh555hhh (via GitHub)" <gi...@apache.org> on 2024/06/11 03:04:41 UTC
Re: [PR] feat(CI):enable markdownlint and typos in docs.yml [incubator-graphar]
ywh555hhh commented on PR #508:
URL: https://github.com/apache/incubator-graphar/pull/508#issuecomment-2159693167
When using Markdownlint for document formatting checks, I encountered some issues that could not be automatically resolved, mainly involving a large number of MD013 (line length is too long) and MD033 (inline HTML) issues, as well as one MD025 (multiple top-level headings) issue.
For example, I encountered MD013 and MD033 issues on line 110 of the `specification/format.md` file, and an MD025 issue in the `libraries/cpp/getting-started.md` file.
To resolve these issues, I have configured Markdownlint to ignore these three types of issues in the `.markdownlint.yaml` configuration file. The specific configuration is as follows:
```yaml
# Ignore MD013, as the document requires longer lines to maintain the integrity of code examples
MD013: false
# Ignore MD033, as inline HTML is necessary in some cases, such as specific formatting requirements
MD033: false
# Ignore MD025, as the document structure requires multiple top-level headings to reflect different sections or parts
MD025: false
```
I believe this is a reasonable solution because these issues are mainly caused by the mismatch between our document format and the default rules of Markdownlint. By customizing our Markdownlint configuration, we can ensure that it better adapts to our document structure and formatting needs.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@graphar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@graphar.apache.org
For additional commands, e-mail: commits-help@graphar.apache.org