Use custom YAML & Markdown validation rules
Browse files- .github/workflows/ci-cd.yaml +1 -1
- .mdlrc +1 -1
- .yamllint +1 -1
- markdownlint.rb +20 -2
.github/workflows/ci-cd.yaml
CHANGED
@@ -25,4 +25,4 @@ jobs:
|
|
25 |
uses: QubitPi/hashistack/.github/workflows/yml-md-style-and-link-checks.yml@master
|
26 |
with:
|
27 |
use-custom-yamllint-config-file: true
|
28 |
-
use-custom-markdownlint-config-file: true
|
|
|
25 |
uses: QubitPi/hashistack/.github/workflows/yml-md-style-and-link-checks.yml@master
|
26 |
with:
|
27 |
use-custom-yamllint-config-file: true
|
28 |
+
use-custom-markdownlint-config-file: true
|
.mdlrc
CHANGED
@@ -1,2 +1,2 @@
|
|
1 |
-
rules "~MD002", "~MD003", "~MD005", "~MD007", "~MD013", "~MD022", "~MD024", "~MD029", "~MD033", "~MD034", "~MD036", "~MD041"
|
2 |
style "#{File.dirname(__FILE__)}/markdownlint.rb"
|
|
|
1 |
+
rules "~MD002", "~MD003", "~MD005", "~MD007", "~MD013", "~MD022", "~MD024", "~MD029", "~MD033", "~MD034", "~MD036", "~MD041", "~MD055", "~MD057"
|
2 |
style "#{File.dirname(__FILE__)}/markdownlint.rb"
|
.yamllint
CHANGED
@@ -16,4 +16,4 @@ rules:
|
|
16 |
min-spaces-after: 1
|
17 |
max-spaces-after: -1
|
18 |
brackets:
|
19 |
-
max-spaces-inside: -1
|
|
|
16 |
min-spaces-after: 1
|
17 |
max-spaces-after: -1
|
18 |
brackets:
|
19 |
+
max-spaces-inside: -1
|
markdownlint.rb
CHANGED
@@ -1,2 +1,20 @@
|
|
1 |
-
|
2 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1 |
+
# Copyright Jiaqi Liu
|
2 |
+
#
|
3 |
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
4 |
+
# you may not use this file except in compliance with the License.
|
5 |
+
# You may obtain a copy of the License at
|
6 |
+
#
|
7 |
+
# http://www.apache.org/licenses/LICENSE-2.0
|
8 |
+
#
|
9 |
+
# Unless required by applicable law or agreed to in writing, software
|
10 |
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
11 |
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
12 |
+
# See the License for the specific language governing permissions and
|
13 |
+
# limitations under the License.
|
14 |
+
|
15 |
+
all
|
16 |
+
rule 'MD003', style: :setext_with_atx
|
17 |
+
rule 'MD004', style: :sublist
|
18 |
+
rule 'MD013', line_length: 120
|
19 |
+
rule 'MD029', style: :ordered
|
20 |
+
rule 'MD026', punctuation: ".,;:!?"
|