Skip to content

Commit

Permalink
Add markdownlint config and github action
Browse files Browse the repository at this point in the history
  • Loading branch information
lornajane committed Nov 17, 2023
1 parent a60f19b commit 40da47a
Show file tree
Hide file tree
Showing 2 changed files with 71 additions and 0 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/markdownlint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Markdown lint
on:
pull_request:
types: [opened, synchronize, reopened]

jobs:
markdownlint:
name: markdownlint
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: articulate/actions-markdownlint@v1
with:
config: markdownlint-config.json
files: 'docs/**/*.md'
ignore: node_modules
version: 0.28.1
54 changes: 54 additions & 0 deletions .markdownlint.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
---
# Default rules: https://github.com/github/super-linter/blob/master/TEMPLATES/.markdown-lint.yml

# Rules by id

# Unordered list style
MD004: false

# Unordered list indentation
MD007:
indent: 2

MD013:
# TODO: Consider to decrease allowed line length
line_length: 800
tables: false

## Allow same headers in siblings
MD024:
siblings_only: true

# Multiple top level headings in the same document
MD025:
front_matter_title: ''

# Trailing punctuation in heading
MD026:
punctuation: '.,;:。,;:'

# Ordered list item prefix
MD029: false

# Unordered lists inside of ordered lists
MD030: false

# Inline HTML
MD033: false

# No bare urls
MD034: false

# Emphasis used instead of a heading
MD036: false

# Disable "First line in file should be a top level heading"
# We use uncommon format to add metadata.
# TODO: Consider to use "YAML front matter".
MD041: false

# Rules by tags
blank_lines: false

MD046: false
# code-block-style

0 comments on commit 40da47a

Please sign in to comment.