Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 14 additions & 15 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,38 +9,37 @@ on: # yamllint disable-line rule:truthy
branches: ["main"]
workflow_dispatch:

env:
node-version: 26.x
markdownlint-version: 0.49.1

permissions:
contents: read

jobs:
markdownlint:
name: Markdown Lint
runs-on: ubuntu-26.04

strategy:
matrix:
node-version: [22.x]
# See supported Node.js release schedule
# at https://nodejs.org/en/about/releases/
runs-on: ubuntu-24.04

steps:
- name: Checkout repository
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7
uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1

- name: Set up Node.js ${{ matrix.node-version }}
- name: Set up Node.js ${{ env.node-version }}
uses: actions/setup-node@v7
with:
node-version: ${{ matrix.node-version }}
node-version: ${{ env.node-version }}

- name: Install dependencies
- name: Install tool
run: >
npm install -g --ignore-scripts markdownlint-cli@0.47.0
npm install -g --ignore-scripts
markdownlint-cli@${{ env.markdownlint-version }}

- name: Test dependencies
run: |
- name: Check tool
run: >
markdownlint --version

- name: Lint
run: >
markdownlint '**/*.md' --ignore node_modules
markdownlint --config .markdownlint.json '**/*.md'
&& echo '✔ Your code looks good.'
130 changes: 130 additions & 0 deletions .markdownlint.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,130 @@
{
"default": true,
"extends": null,
"MD001": true,
"MD002": {
"level": 1
},
"MD003": {
"style": "consistent"
},
"MD004": {
"style": "consistent"
},
"MD005": true,
"MD006": true,
"MD007": {
"indent": 2,
"start_indented": false,
"start_indent": 2
},
"MD009": {
"br_spaces": 2,
"list_item_empty_lines": false,
"strict": false
},
"MD010": {
"code_blocks": true,
"ignore_code_languages": [],
"spaces_per_tab": 1
},
"MD011": true,
"MD012": {
"maximum": 1
},
"MD013": {
"line_length": 80,
"heading_line_length": 80,
"code_block_line_length": 80,
"code_blocks": false,
"tables": true,
"headings": true,
"strict": false,
"stern": false
},
"MD014": true,
"MD018": true,
"MD019": true,
"MD020": true,
"MD021": true,
"MD022": {
"lines_above": 1,
"lines_below": 1
},
"MD023": true,
"MD024": {
"siblings_only": false
},
"MD025": {
"level": 1,
"front_matter_title": "^\\s*title\\s*[:=]"
},
"MD026": {
"punctuation": ".,;:!。,;:!"
},
"MD027": true,
"MD028": true,
"MD029": {
"style": "one_or_ordered"
},
"MD030": {
"ul_single": 1,
"ol_single": 1,
"ul_multi": 1,
"ol_multi": 1
},
"MD031": {
"list_items": true
},
"MD032": true,
"MD033": {
"allowed_elements": []
},
"MD034": true,
"MD035": {
"style": "consistent"
},
"MD036": {
"punctuation": ".,;:!?。,;:!?"
},
"MD037": true,
"MD038": true,
"MD039": true,
"MD040": {
"allowed_languages": [],
"language_only": false
},
"MD041": {
"level": 1,
"front_matter_title": "^\\s*title\\s*[:=]"
},
"MD042": true,
"MD043": {
"headings": ["*"],
"match_case": false
},
"MD044": {
"names": [],
"code_blocks": true,
"html_elements": true
},
"MD045": true,
"MD046": {
"style": "consistent"
},
"MD047": true,
"MD048": {
"style": "consistent"
},
"MD049": {
"style": "consistent"
},
"MD050": {
"style": "consistent"
},
"MD051": true,
"MD052": true,
"MD053": {
"ignored_definitions": ["//"]
}
}
Loading
Loading