Some quality of life docs tooling improvements (#664)

This commit is contained in:
Georgi Matev 2022-08-26 22:03:36 -04:00 committed by GitHub
parent d3bced28f9
commit 802001513f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 19 additions and 4 deletions

View File

@ -5,8 +5,17 @@ Vocab = Base
Packages = Microsoft, proselint, write-good, alex
[formats]
mdx = md
[*]
write-good.E-Prime = NO
[*.md]
BasedOnStyles = Vale, Microsoft, proselint, write-good, alex
BlockIgnores = (\{\#.*?\}), \
(import.*?from.*?;)
[*.json]
BasedOnStyles = Vale

View File

@ -8,14 +8,16 @@ dev:
-p 3000:3000 \
-v ${PWD}:/usr/src/docs alcion/docs
VALE_TARGET ?= docs README.md
dockercheck:
docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs vale docs README.md
-v ${PWD}:/usr/src/docs alcion/docs vale $(VALE_TARGET)
docker run --rm \
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
-v ${PWD}:/usr/src/docs alcion/docs markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
check:
vale docs README.md
vale $(VALE_TARGET)
markdownlint '**/*.md' --ignore styles/ --ignore src/ --ignore node_modules/
shell:

View File

@ -10,6 +10,8 @@ second: '(?:\b[A-Z][a-z]+ )+\(([A-Z]{3,5})\)'
exceptions:
- API
- ASP
- ARM
- AWS
- CLI
- CPU
- CSS
@ -28,6 +30,7 @@ exceptions:
- HTTP
- HTTPS
- IDE
- IAM
- JAR
- JSON
- JSX

View File

@ -1,3 +1,4 @@
Corso
Docusaurus
config
Config