Skip to content

Create ci.yml #20

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

Merged
merged 1 commit into from
Jan 4, 2022
Merged

Create ci.yml #20

merged 1 commit into from
Jan 4, 2022

Conversation

bsdelf
Copy link
Contributor

@bsdelf bsdelf commented Jan 4, 2022

Use GitHub Action to run CI, all CI does is lint markdown files with mdl command, see https://github.com/markdownlint/markdownlint project.

Currently, the default rules of mdl already found some issues in bunch of files:

% mdl * | grep "MD\d\+.*$" -o | sort | uniq
MD001 Header levels should only increment by one level at a time
MD004 Unordered list style
MD009 Trailing spaces
MD012 Multiple consecutive blank lines
MD025 Multiple top level headers in the same document
MD029 Ordered list item prefix
MD030 Spaces after list markers
MD032 Lists should be surrounded by blank lines
MD036 Emphasis used instead of a header

Most of the default rules are fine, except:

  • MD004: :dash should be preferred, because - only needs a single key stroke while * requires shift
  • MD029: it's hard to say which one is better, but :one definitely makes life easier.

I suggest we should discuess about the rules, once aligned I can add a config file for mdl and fix remaining lint issues in PR.

@Anduin2017 Anduin2017 merged commit 849f988 into Anduin2017:master Jan 4, 2022
@bobby285271
Copy link
Collaborator

Just a note that with the new file structure introduced in b15b22e, mdl no longer tries to lint markdown files other than README.md due to the current wildcard *.md. While I believe simply changing *.md to . should fix this, pull requests are welcomed if you have better solutions.

bobby285271 added a commit that referenced this pull request Feb 21, 2022
Note that markdownlint does not lint markdown files other than README.md currently, see
#20 (comment) for more details.
QYDIY pushed a commit to QYDIY/HowToCook that referenced this pull request Feb 22, 2022
Note that markdownlint does not lint markdown files other than README.md currently, see
Anduin2017#20 (comment) for more details.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants