Add markdown one-line-per-line layout rule #41
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
This adds a markdown specification document. Please see exercism/configlet#150 (comment) for the rationale of these choices.
Co-authored-by: Sascha Mann <[email protected]>
ErikSchierboom
approved these changes
Feb 4, 2021
Co-authored-by: Erik Schierboom <[email protected]>
Co-authored-by: Erik Schierboom <[email protected]>
coriolinus
approved these changes
Feb 4, 2021
There was a problem hiding this comment.
Seems plausible, but likely to run into conflicts with MD013. Might be worth documenting that this is intentional and that that rule should be disabled in markdown linters for exercism files.
|
@coriolinus Thanks. I've added #45 to address that. |
* Add linting rules * Update contributing/standards/markdown.md Co-authored-by: Erik Schierboom <[email protected]> Co-authored-by: Erik Schierboom <[email protected]>
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.
This is a potentially controversial change. It was previous discussed here.
I think this is a strong positive change for documents that are consumed in their rendered format.
My main concern/uncertainty is whether this makes exercises downloaded in the CLI harder to consume. If there was consensus that it's a negative change in that context, then I'd consider enforcing this in places that are only rendered on the website.