Skip to content

Commit 39d6c08

Browse files
committed
Add docs contributor README
1 parent 40885c7 commit 39d6c08

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# Docs Contributions
2+
3+
Docs contributors should be aware of the following extensions, with the corresponding
4+
settings files, that were used in developing these docs:
5+
6+
- [MarkdownLinter](https://github.com/DavidAnson/markdownlint):
7+
- `.markdownlint.yaml` establishes settings for various
8+
[linter rules](https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md)
9+
- `.vscode/settings.json` formatting on save to fix linting
10+
11+
- [CSpell](https://github.com/streetsidesoftware/vscode-spell-checker): `cspell.json`
12+
has various ignored words.
13+
14+
- [ReWrap](https://github.com/stkb/Rewrap/): `.vscode/settings.json` allows toggling
15+
automated hard wrapping for files at 88 characters. This can also be keymapped to be
16+
performed on individual paragraphs, see documentation.

0 commit comments

Comments
 (0)