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.

Sign up for GitHub

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

Jump to bottom

Internal header link verification does not work #65

Closed
cmelchior opened this issue Oct 4, 2018 · 1 comment
Closed

Internal header link verification does not work #65

cmelchior opened this issue Oct 4, 2018 · 1 comment
Labels
duplicate This issue was already asked, please comment on the original one

Comments

@cmelchior
Copy link

It looks like checking headers internally in a markdown file doesn't work.

A simple repo-case:

test.md

# Header
[Link to header](#foo)

Test:

 => markdown-link-check ./test.md 

FILE: ./test.md
[✓] #foo
@eysi09 eysi09 mentioned this issue Oct 4, 2019
Closed
eysi09 added a commit to garden-io/garden that referenced this issue Oct 4, 2019
@eysi09
docs: ensure check-docs script checks internal header links
1f7db54 
markdown-check-link doesn't check internal header links. This is a
known issue (tcort/markdown-link-check#65).

We therefore add a new tool to check for internal links and limit
markdown-check-link to external links.

The new tool is from the remark family of markdown tools and expects
anchor links to not include any special characters so we also had to
make appropriate changes to the docs generator functions.

Finally, this commit fixes broken links discovered because of these
fixes.
@eysi09 eysi09 mentioned this issue Oct 4, 2019
Merged
eysi09 added a commit to garden-io/garden that referenced this issue Oct 7, 2019
@eysi09
docs: ensure check-docs script checks internal header links
24ed88e 
markdown-check-link doesn't check internal header links. This is a
known issue (tcort/markdown-link-check#65).

We therefore add a new tool to check for internal links and limit
markdown-check-link to external links.

The new tool is from the remark family of markdown tools and expects
anchor links to not include any special characters so we also had to
make appropriate changes to the docs generator functions.

Finally, this commit fixes broken links discovered because of these
fixes.
@nex3 nex3 mentioned this issue Nov 27, 2019
Closed
@NicolasMassart
Copy link
Contributor

Moving this discussion to #91
Thanks

@NicolasMassart NicolasMassart added the duplicate This issue was already asked, please comment on the original one label Sep 26, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
duplicate This issue was already asked, please comment on the original one
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@cmelchior @NicolasMassart