iskm/learnxinyminutes-docs
1
0
Fork 0
mirror of https://github.com/adambard/learnxinyminutes-docs.git synced 2024-12-23 17:41:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add hint to markdownlint

Browse Source 
In the longer term, the use of a linter (similar to pylint for
Python) may contribute to easier maintenance of the markdown files
and consistent display of the content on the web page.
This commit is contained in:
Norwid Behrnd 2022-11-30 14:28:20 +01:00
parent eddf5accb8
commit 23a2d02f7f
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
CONTRIBUTING.markdown
View File

@ -19,6 +19,9 @@ review them more effectively and/or individually.
* **Keep lines under 80 chars** * **Keep lines under 80 chars**
* Try to keep **line length in code blocks to 80 characters or fewer**. * Try to keep **line length in code blocks to 80 characters or fewer**.
* Otherwise, the text will overflow and look odd. * Otherwise, the text will overflow and look odd.
* This and other potential pitfalls to format the content consistently are
identified by the freely available
[markdownlint](https://github.com/markdownlint/markdownlint).
* **Prefer example to exposition** * **Prefer example to exposition**
* Try to use as few words as possible. * Try to use as few words as possible.
* Code examples are preferred over exposition in all cases. * Code examples are preferred over exposition in all cases.