docs: update markdownlint rules for better formatting
This commit is contained in:
27
.github/linters/.markdown-lint.yml
vendored
27
.github/linters/.markdown-lint.yml
vendored
@@ -8,3 +8,30 @@ MD013: false
|
||||
# Inline HTML
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md033
|
||||
MD033: false
|
||||
|
||||
# List indentation
|
||||
# 2 spaces breaks list formatting in mkdocs
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md007
|
||||
MD007:
|
||||
indent: 4
|
||||
|
||||
# Fenced code blocks should have a language specified
|
||||
# We use a second, un-languaged code block to denote the output
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md040
|
||||
MD040: false
|
||||
|
||||
# Blank line inside blockquote
|
||||
# This is typically done when a section has a "New as of" or "Warning" in addition to a note
|
||||
# May wish to take advantage of github-style admonitions
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md028
|
||||
MD028: false
|
||||
|
||||
# No duplicate headers
|
||||
# HISTORY.md has a ton of these
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md024
|
||||
MD024: false
|
||||
|
||||
# First line h1
|
||||
# The issue template doesn't have one
|
||||
# https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md#md041
|
||||
MD041: false
|
||||
|
||||
14
.github/workflows/lint.yml
vendored
14
.github/workflows/lint.yml
vendored
@@ -27,12 +27,16 @@ jobs:
|
||||
steps:
|
||||
- name: Clone
|
||||
uses: actions/checkout@v3
|
||||
- name: Run markdown-lint
|
||||
uses: avto-dev/markdown-lint@04d43ee9191307b50935a753da3b775ab695eceb
|
||||
# v1.5.0 => 04d43ee9191307b50935a753da3b775ab695eceb
|
||||
- name: Setup node
|
||||
uses: actions/setup-node@v3
|
||||
with:
|
||||
config: '.github/linters/.markdown-lint.yml'
|
||||
args: './README.md'
|
||||
node-version: '20'
|
||||
cache: 'npm'
|
||||
cache-dependency-path: '.github/workflows/lint.yml'
|
||||
- name: Install markdownlint-cli
|
||||
run: npm install -g markdownlint-cli@0.35.0
|
||||
- name: Run markdown-lint
|
||||
run: markdownlint -c .github/linters/.markdown-lint.yml *.md **/*.md
|
||||
|
||||
packer:
|
||||
name: packer
|
||||
|
||||
Reference in New Issue
Block a user