Start with Markdownlint for vscode editing #1377
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Jerome Luckenbach <github@luckenba.ch>
Confectrician
changed the title
|
✔️ Thanks for your pull request to the openHAB documentation! The result can be previewed at the URL below (this comment and the preview will be updated if you add more commits). 🔨 Explore the source changes: d4a3af2 🔍 Inspect the deploy logs: https://app.netlify.com/sites/openhab-docs-preview/deploys/5fe6199b32319c4512ea5e5c 😎 Browse the preview: https://deploy-preview-1377--openhab-docs-preview.netlify.app |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Including some initial linting error fixes as showcase.
This is on the todo list for a very long time.
We have discussed about several solutions with several possible editors.
Since vscode has become quite popular meanwhile and many people are using it anyway for their openHAB environments i want to give it another try.
VSCode can handle Markdown editing by default in a basic matter.
This PR introduces a custom configuration for the https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint extension.
It will apply some default linting with custom rules we have configured in this repo on top.
This way we can make sure that everyone uses the same ruleset and we can establish some kind of markdown standard for the future.
The handling was pretty easy so far.
There is a set of standard fixes that can be applied automatically with one command.
Mostly there are ony a few markdown errors left, that need some attention.
References: #50 #196 #999
Signed-off-by: Jerome Luckenbach github@luckenba.ch