Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make it possible to disable the absolute link rule #505

Merged
merged 1 commit into from
Nov 19, 2024

Conversation

ptgott
Copy link
Contributor

@ptgott ptgott commented Nov 15, 2024

Export remarkLintTeleportDocsLinks using lintRule, naming the rule remark-lint:absolute-docs-links. This means that a docs author can disable the linter within a page by adding the following:

{/* lint disable absolute-docs-links */}

@ptgott ptgott requested a review from avatus as a code owner November 15, 2024 22:52
Copy link

vercel bot commented Nov 15, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 19, 2024 4:04pm

Export `remarkLintTeleportDocsLinks` using `lintRule`, naming the rule
`remark-lint:absolute-docs-links`. This means that a docs author can
disable the linter within a page by adding the following:

```
{/* lint disable absolute-docs-links */}
```
@ptgott ptgott force-pushed the paul.gottschling/2024-11-15-disable-abs-links branch from 410deef to 83aebb6 Compare November 19, 2024 15:51
@ptgott ptgott marked this pull request as ready for review November 19, 2024 15:51
@ptgott
Copy link
Contributor Author

ptgott commented Nov 19, 2024

Reviewer note: you need to run yarn build-node after pulling the branch and installing dependencies in order to test this locally. I forgot to do that and ended up debugging for a couple hours 🤦 .

Copy link
Contributor

@avatus avatus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I forgot to do that and ended up debugging for a couple hours

that is the worst! thanks for the tip

@ptgott ptgott merged commit 0b723cb into main Nov 19, 2024
5 of 6 checks passed
ptgott added a commit to gravitational/docs-website that referenced this pull request Dec 9, 2024
ptgott added a commit to gravitational/docs-website that referenced this pull request Dec 11, 2024
Apply gravitational/docs#505

Also fix type errors required to transpile our remark linters from
TypeScript.
ptgott added a commit to gravitational/docs-website that referenced this pull request Dec 11, 2024
Apply gravitational/docs#505

Also fix type errors required to transpile our remark linters from
TypeScript.
ptgott added a commit to gravitational/docs-website that referenced this pull request Dec 11, 2024
Apply gravitational/docs#505

Also fix type errors required to transpile our remark linters from
TypeScript.
ptgott added a commit to gravitational/docs-website that referenced this pull request Dec 16, 2024
Apply gravitational/docs#505

Also fix type errors required to transpile our remark linters from
TypeScript.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants