diff --git a/docs/.vale.ini b/docs/.vale.ini index db2897041..1b63e99df 100644 --- a/docs/.vale.ini +++ b/docs/.vale.ini @@ -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 diff --git a/docs/Makefile b/docs/Makefile index c4ab57f90..3f658b555 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -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: diff --git a/docs/styles/Microsoft/Acronyms.yml b/docs/styles/Microsoft/Acronyms.yml index 308ff7c0e..366edbfe4 100644 --- a/docs/styles/Microsoft/Acronyms.yml +++ b/docs/styles/Microsoft/Acronyms.yml @@ -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 diff --git a/docs/styles/Vocab/Base/accept.txt b/docs/styles/Vocab/Base/accept.txt index e43cc9337..dbae1d170 100644 --- a/docs/styles/Vocab/Base/accept.txt +++ b/docs/styles/Vocab/Base/accept.txt @@ -1,3 +1,4 @@ Corso Docusaurus - +config +Config