Initial Markdown linting (#1978)

This commit is contained in:
Nagy-Egri Máté Ferenc
2023-03-22 15:45:50 +01:00
committed by GitHub
parent e9ee6b9874
commit 8702d500ad
3 changed files with 21 additions and 0 deletions

14
.github/workflows/markdownlint.yml vendored Normal file
View File

@@ -0,0 +1,14 @@
name: Markdownlint Action
on: push
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Check out code
uses: actions/checkout@v3
- name: Use markdownlint
uses: actionshub/markdownlint@v3.1.3
with:
filesToIgnoreRegex: "CHANGELOG.md|README.md|docs/packaging_guidelines.md|docs/about.md|docs/quick_start.md|docs/index.md|docs/release/gpu_os_support.md|docs/how_to/magma_install/magma_install.md|docs/reference/gpu_libraries/math.md|docs/reference/rocmcc/rocmcc.md|docs/reference/docker.md|docs/reference/hip.md|docs/hip_sdk_install_win/hip_sdk_install_win.md|docs/all_deploy_options.md"

1
.mdlrc Normal file
View File

@@ -0,0 +1 @@
style "mdlrc-style.rb"

6
mdlrc-style.rb Normal file
View File

@@ -0,0 +1,6 @@
all
# Extend line length
rule 'MD013', :line_length => 99999
# Allow in-line HTML
exclude_rule 'MD033'