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

jekyll-relative-links doesn't update links in markdown #45

Closed
ghost opened this issue May 28, 2018 · 0 comments
Closed

jekyll-relative-links doesn't update links in markdown #45

ghost opened this issue May 28, 2018 · 0 comments
Assignees

Comments

@ghost
Copy link

ghost commented May 28, 2018

The official docs state that this gem/plugin is a default plugin that cannot be disabled. However, it doesn't appear to work at all when deployed to github or locally.

From the README.md:

What it does

Let's say you have a link like this in a Markdown file: [foo](bar.md)
While that would render as a valid link on GitHub.com, it would not be a valid link on Pages.
Instead, this plugin converts that link to: [foo](bar.html)

It's supposed to make relative markdown links work without modification when deployed to gh-pages. Some of the things that could be handled by this plugin are currently being handled by the docs gulp task.

foo.md and the adjacent bar.md are converted to foo/index.html and bar/index.html respectively by the Jekyll build process.

A relative link in foo.md must refer to bar/index.html by ../../bar thus the normal ../bar.md and/or simply bar.md must be converted for links to work properly.

TL;DR

This link conversion process adds some (would be) unnecessary complexity to current build scripts. It would be better if we could get this plugin to work to simplify things.

Relevant Issues:

@ghost ghost mentioned this issue May 29, 2018
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

No branches or pull requests

1 participant