generated from it-at-m/oss-repository-en-template
-
Notifications
You must be signed in to change notification settings - Fork 7
Open
Labels
Priority: IceboxIssues that we currently dont want to work onIssues that we currently dont want to work onType: DocumentationThe issue contains work for the documentationThe issue contains work for the documentationType: MaintenanceThe issue contains maintenance work.The issue contains maintenance work.
Description
Relevant template
No response
Problem description (optional)
We can even more improve the linting for documentation by adding a spell checking mechanism to the contents of our markdown files.
Desired solution
I researched some possible tools (which support markdown files and are all available via node packages) and found
- https://github.com/textlint/textlint (npm dependency, actively maintained, rules need to be installed separately)
- https://github.com/streetsidesoftware/cspell
- https://github.com/lukeapage/node-markdown-spellcheck
We need to check which rules are useful (if any).
Considered alternatives (optional)
No response
Additional context (optional)
No response
No duplicate
- I confirm that this issue is not a duplicate
Code of Conduct
- I agree to follow this project's Code of Conduct
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
Priority: IceboxIssues that we currently dont want to work onIssues that we currently dont want to work onType: DocumentationThe issue contains work for the documentationThe issue contains work for the documentationType: MaintenanceThe issue contains maintenance work.The issue contains maintenance work.
Type
Projects
Status
In Progress