Validate links for Foliant projects

[remarkjs]

Validate links for Foliant projects

[wooorm]

This project is more for Git repositories, such as this one, hosted on GitHub/Gitlab/Bitbucket.
I do not know Foliant but I’m guessing it’s very different and that supporting it is essentially a fork of this project?

It might be of interest to note that you can already somewhat integrate with this project: https://github.com/remarkjs/remark-validate-links#integration.

[holamgadol]

@wooorm Foliant projects are also Git repositories. These projects can be considered as a special case of MkDocs SSG repo. So these features can be used not only for Foliant, but for SSG projects.

[wooorm]

Please explain what isn’t working for them, then. Because apparently they have custom links.

Note: the “hosted on GitHub/Gitlab/Bitbucket” part I listed is important. This project is not for any random website or whatever maintained on a file system, but for projects that have markdown which is rendered on GitHub/Gitlab/Bitbucket

[holamgadol]

Proposed features:

• extract multiple refs from headings with custom ID
  #Long Heading {#shortref} should produce long-heading and shortref
• treat local links according to the MkDocs directory structure
  ../../document-folder/document/#anchor should produce ../document-folder/document.md#anchor
• treat links like ./#heading as a link to an anchor heading
• option to turn off lowercase in hash
  hash = url.slice(numberSignIndex)

Foliant projects are hosted on GitHub/Gitlab/Bitbucket, but rendered by another tools as static web site

[wooorm]

1. should be done with a plugin to add support for that custom syntax so that remark understands it
2. you can have a plugin that rewrites URLs matching Foliant, however, I believe this is outside of the scope of this project, because this project matches how markdown files on GitHub/Gitlab/Bitbucket link to each other, and not how particular static-site generators do their work. There is a lot of logic in this project that you don’t need. A separate project that say, checks the result of any static-site generator and works on rehype instead of remark, would be more useful to you
3. I believe that works
4. I do not understand this one

but rendered by another tools as static web site

With “hosted”, I mean that links in markdown files here, which point to other markdown files here, match according to how GitHub/Gitlab/Bitbucket do that. So in your parlance, I mean whether links will work assuming the markdown is rendered on GitHub/Gitlab/Bitbucket.

That is to contrast it with Foliant’s behavior that you describe, for things such as ../../document-folder/document/#anchor. Those do not work on GitHub/Gitlab/Bitbucket.

[holamgadol]

@wooorm thank you the response. I helped me to understand my requirements better.
I'll check the possibility of a separate project for linting local links in Foliant projects

4. I do not understand this one

MkDocs preserve letter case in anchors, so I needed an option to turn the lowercase off

[wooorm]

Cool :) Good luck!