Skip to content

Docs: Fix reference links and remove markdownlint-cli dependency #1566

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

Merged
merged 1 commit into from
Dec 4, 2018
Merged

Docs: Fix reference links and remove markdownlint-cli dependency #1566

merged 1 commit into from
Dec 4, 2018

Conversation

molant
Copy link
Member

@molant molant commented Dec 3, 2018

Pull request checklist

Make sure you:

For non-trivial changes, please make sure you also:

  • Added/Updated related documentation.

Short description of the change(s)

Create a custom rule for markdownlint that validates that a link
reference is valid and replace the calls to markdownlint-cli to the
new script in all packages.

markdownlint-cli does not have a way to add custom rules, you need to
use the API to do so and thus markdownlint-cli is no longer needed as
a dependency.


Ref: #1436

@molant
Copy link
Member Author

molant commented Dec 3, 2018

This is how the errors look like:

image

@molant molant added this to the 1812-1 milestone Dec 3, 2018
Create a custom rule for `markdownlint` that validates that a link
reference is valid and replace the calls to `markdownlint-cli` to the
new script in all packages.

`markdownlint-cli` does not have a way to add custom rules, you need to
use the API to do so and thus `markdownlint-cli` is no longer needed as
a dependency.

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

Ref: #1436
Copy link
Member

@antross antross left a comment

Choose a reason for hiding this comment

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

Looks good to me.

@sarvaje once you have a chance to look at this I'll merge it in. I can also update the PR first if needed.

Copy link
Contributor

@sarvaje sarvaje left a comment

Choose a reason for hiding this comment

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

LGTM

@antross antross merged commit c412f9a into webhintio:master Dec 4, 2018
@molant molant deleted the fix/reference-links branch January 10, 2019 04:56
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.

3 participants