Commit Graph

7 Commits

Author SHA1 Message Date
Mayursinh Sarvaiya 5c6a0356c0 feat: TechDocs - Add vale linter to check words quality in md files. (#2631)
* fix(docs): typos which were reflacted from vale linter's command

* feat: Implement Vale linter (#2031)
Initialize .vale.ini file
Add 'lint:docs' script to package.json, to lint all md files except the ones which are located in node_modules
Generate 'vocab.txt' by using command 'yarn run lint:docs' | grep -o ''[a-z A-Z]*'' | grep -o '[a-z A-Z]*' | sort | uniq > .github/styles/vocab.txt
Add steps to github workflow 'master' to check docs quality

* chore: Separate workflow for quality checking

* chore: Added 'shx' dev dependency to support grep command in cross platform

* feat: Add script to operate same quality check process on different platform

* ignore: remove lint:docs from lint-stages which was added for experiment purpose

* fix: check-all-files on push event & check-changed-files on pull_request event

* chore(CI): triggle workflow only when there is any updates in .md file(s) on pull request

* fix: use spawnSync to solve 'The command line is too long.' error

* fix: github workflow syntax

* fix: prettier error

* chore: add vale command directly to lint-staged

* chore: use shebang for easy access

* fix: windows script issue & remove shebang

* chore: Add shebang flag

* chore: better error message related to vale

* chore: mention vale linter in documentation

* fix: spelling errors & add keywords to vocab.txt
2020-10-02 07:20:47 +02:00
Emma Indal 959e2e9866 TechDocs: adjust mkdocs extensions (#2516)
* fix(techdocs-core): adjust mkdocs extensions

* fix(techdocs-core): formatting

* fix(techdocs-core): bump version)

* move highlight configs to extension

* delete extension from mkdocs yaml

* formatting

* fix(docs): add links to plugins and extensions in docs

* prettier

* fix(techdocs-core): use pymdownx extensions v.7.1 to allow legacy_tab_classes config

* fix(techdocs-core): delete unused import

* update changelog

* added superfences to list of extensions

* prettier
2020-09-21 18:03:13 +02:00
Emma Indal 2b555ca1d9 TechDocs: fix pymdown emoji configs (#2482)
* fix pymdown emoji configs

* Added changelog, bumped version

Co-authored-by: Sebastian Qvarfordt <s.qvarfordt@gmail.com>
2020-09-16 11:18:48 +02:00
Patrik Oldsberg b045b166b6 run prettier 2020-09-05 16:37:30 +02:00
Sebastian Qvarfordt 043b0d927d TechDocs: Added more plugins to mkdocs (#2215)
* Added more plugins to mkdocs

* Added missing file

* wait with katex extension

* delete math equations example

* add changelog to readme to keep track of changes

* Updated plantuml executable in dockerfile

* Update packages/techdocs-container/Dockerfile

Co-authored-by: Emma Indal <emmai@spotify.com>
2020-09-03 10:11:02 +02:00
Sebastian Qvarfordt 891b1cebb7 feature(techdocs-core): Initial version of metadata generation of mkdocs data 2020-07-29 11:49:01 +02:00
Bilawal Hameed 4f709b4a25 fix: migrate techdocs-container to packages/ 2020-07-10 16:05:14 +02:00