-
Notifications
You must be signed in to change notification settings - Fork 94
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
Add a remark plugin to support custom header id #245
Add a remark plugin to support custom header id #245
Conversation
Allows validation of custom headers via remark-validate-links
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Approved for the basic functionality, but I want to note that this repo has special --ignore-patterns
configured for the src/_includes
and src/pages/graphql/schema
directories.
For background, we originally added these patterns because of the false positives with custom header IDs. However, we've since expanded that to ignore frontmatter for the graphql schema directories. I assume we also need to ignore the _includes in the frontmatter checks as well.
Ideally, we would not ignore directories when testing.
But maybe the frontmatter config makes it unnecessary to use CLI ignore patterns: https://github.com/AdobeDocs/commerce-webapi/blob/main/.remarkrc.mjs#L17. |
The issue should be fixed by using remark-heading-id
Coincidentally, in #246 I just deleted nearly 50 schema files that are no longer necessary now that the GraphQL schema docs link directly to SpectaQL. I don't know if it'll be possible to remove the pattern, but the remaining include files probably don't link to other include files. |
…merce-webapi into ds_custom-header-check
@jeff-matthews please create a ticket for me to investigate the issue. |
@dshevtsov, I created #247, which I think will eliminate the need for the |
Purpose of this pull request
This pull request (PR) adds a remark-heading-id plugin that allows validation of custom headers via remark-validate-links.
Test
See AdobeDocs/commerce-admin-developer#85