fix(docs): add markdownlint and apply rules #4557
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
jippi
requested review from
chenrui333,
lukemassa and
X-Guardian
and removed request for
a team
|
gonna take a look |
chenrui333
reviewed
May 14, 2024
|
|
||
| [*.md] | ||
| indent_style = space | ||
| indent_size = 3 |
There was a problem hiding this comment.
I mentioned it in the OP too; lots of files seem to have 3 indentation size, rather than even, so went with it to make sure its consistent - reindenting to 2 or 4 is something I can do as a follow-up (going to be braindead work lol)
There was a problem hiding this comment.
oh okay, let's followup on this 😄
jippi
commented
May 14, 2024
| @@ -1,3 +1,6 @@ | |||
| --- | |||
| aside: false | |||
There was a problem hiding this comment.
these hides the right nav; those page looks better without them, and it only has a single item there anyway
chenrui333
approved these changes
May 14, 2024
|
Love it, 🚢 |
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.
what
npm run website:lintto check lintingnpm run website:lint-fixto check + fix linting where possible.editorconfigto ensure indentation and such are consistent out the box (I picked the oddindent_size: 3since it what most docs seem to be indented with, normally its 2 or 4, but thats something for future improvements?)why
Consistency is nice
tests
N/A
references
N/A