Get yarn markdown-lint to work
#21
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
On `gravitational/docs`, the `yarn markdown-lint` script runs the docs site's `remark`-based linters on the Teleport documentation content. This change ensures that the script works as expected on Docusaurus content. - Add dependencies for `yarn markdown-lint`. - Add a `build-remark` script for building remark plugins in order to run the linter. - Copy `.remarkrc.mjs` from `gravitational/docs`, but add an `updatePaths` function to remark-includes to work with the plugin's new interface. - Edit `getVersionFromFile` to accommodate linting. Get a version if the file is currently in the `content` directory, which we need to do in order to get `remarkIncludes` to work when linting files in `content`. Also add branching in `getCurrentDir` to work with the structure of the `content` directory. - Update package.json to use the versions of `remark` packages found in gravitational/docs. This minimizes the content changes we'll need to make to accommodate the linting configuration.
|
@ptgott seems like you need to review some dependencies |
taraspos
reviewed
Nov 4, 2024
package.json
Outdated
| "unist-util-visit-parents": "^6.0.1", | ||
| "unist-util-find": "^1.0.2", | ||
| "unist-util-visit": "4.1.0", | ||
| "unist-util-visit-parents": "^5.1.0", |
There was a problem hiding this comment.
Seems like some dependencies got downgraded
There was a problem hiding this comment.
I was trying to replicate our gravitational/docs configuration to minimize new linting errors. I had to fix new linting errors anyway, so I've reverted these downgrades
taraspos
reviewed
Nov 4, 2024
package.json
Outdated
| @@ -45,12 +46,12 @@ | |||
| "@mdx-js/react": "^3.0.0", | |||
| "clsx": "^2.1.1", | |||
| "date-fns": "^3.6.0", | |||
| "highlightjs-terraform": "https://github.com/highlightjs/highlightjs-terraform#eb1b9661e143a43dff6b58b391128ce5cdad31d4", | |||
There was a problem hiding this comment.
Any reason why this is needed?
There was a problem hiding this comment.
We used this to enable HCL syntax highlighting in the previous docs site. We're using Docusaurus-native syntax highlighting now, so we shouldn't need this until (potentially) we address #6
- Revert some dependency downgrades - Remove highlightjs-terraform
ptgott
force-pushed
the
paul.gottschling/2024-10-31-md-lint
branch
from
f9f5dfe
to
cb937e5
Compare
It is not enabled in CI, and has led to issues with rate limiting from third-party sites in the past.
taraspos
approved these changes
Nov 5, 2024
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.
On
gravitational/docs, theyarn markdown-lintscript runs the docs site'sremark-based linters on the Teleport documentation content. This change ensures that the script works as expected on Docusaurus content.yarn markdown-lint.build-remarkscript for building remark plugins in order to run the linter..remarkrc.mjsfromgravitational/docs, but add anupdatePathsfunction to remark-includes to work with the plugin's new interface.getVersionFromFileto accommodate linting. Get a version if the file is currently in thecontentdirectory, which we need to do in order to getremarkIncludesto work when linting files incontent. Also add branching ingetCurrentDirto work with the structure of thecontentdirectory.remarkpackages found in gravitational/docs. This minimizes the content changes we'll need to make to accommodate the linting configuration.