Skip to content

Commit ee6675d

Browse files
TC-MOhonzajavorek
authored andcommitted
docs: new vale rule
new rule looking for H1's slight adjustments to accept.txt & .vale.ini
1 parent d0d273a commit ee6675d

File tree

3 files changed

+9
-3
lines changed

3 files changed

+9
-3
lines changed

.github/styles/Apify/H1.yml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
extends: existence
2+
message: 'Do not use H1 headings (#). The main title is generated automatically. Please use H2 (##) or lower.'
3+
level: error
4+
scope: heading.h1

.github/styles/config/vocabularies/Docs/accept.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,3 @@
1-
\bApify\b(?:-\w+)?
2-
@apify\.com
31
SDK(s)
42
[Ss]torages
53
Crawlee
@@ -84,6 +82,7 @@ preconfigured
8482
[Tt]rello
8583
[Pp]refill
8684
[Gg]umloop
85+
[Aa]pify
8786

8887
[Mm]ultiselect
8988

.vale.ini

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@ TokenIgnores = (<\/?[A-Z][^>]*>), ([^\n]+=[^\n]*), ([^\n]+@[^\n]+\.[^\n]), ({[^}
1616
# Ignore HTML comments and Markdown code blocks
1717
BlockIgnores = (?s) (<!--.*?-->)|(```.*?```)
1818
Vale.Spelling = YES
19-
19+
Apify.H1 = error
20+
Apify.Apify = warning
21+
Apify.Capitalization = error
22+
Apify.Languages = warning
2023

2124
# Disabling rules (NO)
2225
Microsoft.Dashes = NO

0 commit comments

Comments
 (0)