Create a gist now

Instantly share code, notes, and snippets.

@olov /references.rb
Last active Sep 25, 2015

What would you like to do?
Jekyll markdown references plugin by Olov Lassus: Keep all your markdown reference-style link definitions in one file (_references.md)
# references.rb has moved to https://github.com/olov/jekyll-references
@mytharcher

This comment has been minimized.

Show comment Hide comment
@mytharcher

mytharcher May 21, 2012

It doesn't work both on GitHub and my local. I forked one and did some fix for my local, but also can't work on GitHub.

Jekyll issue here: #557.

It doesn't work both on GitHub and my local. I forked one and did some fix for my local, but also can't work on GitHub.

Jekyll issue here: #557.

@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 21, 2012

I'll gladly merge your changes into my version to simplify things on the Jekyll plugins page, with proper credit to you of course. But I would like to understand your issue first, and I haven't been able to reproduce it. I'm running Jekyll 0.11.2.

Can you provide more detail such as error messages and your _references.md? Does it work better if you disable any other plugins you may have installed? Thanks!

Owner

olov commented May 21, 2012

I'll gladly merge your changes into my version to simplify things on the Jekyll plugins page, with proper credit to you of course. But I would like to understand your issue first, and I haven't been able to reproduce it. I'm running Jekyll 0.11.2.

Can you provide more detail such as error messages and your _references.md? Does it work better if you disable any other plugins you may have installed? Thanks!

@mytharcher

This comment has been minimized.

Show comment Hide comment
@mytharcher

mytharcher May 22, 2012

I'm so sorry! I don't know why but It works now! I just switch Jekyll version to 0.11.0 and switched back to 0.11.2, then both are OK.

BTW, I found why I can't run any plugins on GitHub, the issue here: #325.

I'm so sorry! I don't know why but It works now! I just switch Jekyll version to 0.11.0 and switched back to 0.11.2, then both are OK.

BTW, I found why I can't run any plugins on GitHub, the issue here: #325.

@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 22, 2012

I guess that's a good thing. :) I cleaned up the plugins-page again. Where you able to trigger a bug if not prepending refs_content with newlines? If so I'll add that to my gist.

Owner

olov commented May 22, 2012

I guess that's a good thing. :) I cleaned up the plugins-page again. Where you able to trigger a bug if not prepending refs_content with newlines? If so I'll add that to my gist.

@mytharcher

This comment has been minimized.

Show comment Hide comment
@mytharcher

mytharcher May 22, 2012

Yes, really it happens. I guess it may be the problem I met before. This a Markdown code in tail of a file:

...
-EOF-(without newlines)

then your converter can't recognize references. If I put a newline, then it works right.

And I think if putting the appending process in MarkdownConverter may be better and clear. So I made my fix in my fork.

Yes, really it happens. I guess it may be the problem I met before. This a Markdown code in tail of a file:

...
-EOF-(without newlines)

then your converter can't recognize references. If I put a newline, then it works right.

And I think if putting the appending process in MarkdownConverter may be better and clear. So I made my fix in my fork.

@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 22, 2012

Thanks. I'm able to reproduce that issue. I've fixed it in the gist by inserting a newline between content and the references.

Owner

olov commented May 22, 2012

Thanks. I'm able to reproduce that issue. I've fixed it in the gist by inserting a newline between content and the references.

@spockz

This comment has been minimized.

Show comment Hide comment
@spockz

spockz Sep 13, 2012

This doesn't work with the following setting

{% capture content %}
Foo [some link][some-id] bar.
{% endcapture %}

It will complain that some-id is not known. (And yes it is inside a file called _references.md.)

spockz commented Sep 13, 2012

This doesn't work with the following setting

{% capture content %}
Foo [some link][some-id] bar.
{% endcapture %}

It will complain that some-id is not known. (And yes it is inside a file called _references.md.)

@spockz

This comment has been minimized.

Show comment Hide comment
@spockz

spockz Sep 13, 2012

Err, that code should have read as follows:

{% capture content %}
Foo [some link][some-id] bar.
{% endcapture %}

{{ content | markdownify }}

spockz commented Sep 13, 2012

Err, that code should have read as follows:

{% capture content %}
Foo [some link][some-id] bar.
{% endcapture %}

{{ content | markdownify }}
@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 6, 2013

@spockz The plugin works on the markdown file level in such a way that it just concatenates _references.md to the end at every .md file it is about to process (it hooks into read_yaml).

For your use-case, we should instead hook into the Markdown class (convert method). That should be pretty straight-forward. Feel free to take a stab at it yourself (please poke me if so) - I may or may not get around to doing it myself.

Owner

olov commented May 6, 2013

@spockz The plugin works on the markdown file level in such a way that it just concatenates _references.md to the end at every .md file it is about to process (it hooks into read_yaml).

For your use-case, we should instead hook into the Markdown class (convert method). That should be pretty straight-forward. Feel free to take a stab at it yourself (please poke me if so) - I may or may not get around to doing it myself.

@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 6, 2013

@spockz Alright I changed the hook so it should work now

Owner

olov commented May 6, 2013

@spockz Alright I changed the hook so it should work now

@olov

This comment has been minimized.

Show comment Hide comment
@olov

olov May 6, 2013

This Gist has moved to a GitHub project for easier collaboration. Get it from https://github.com/olov/jekyll-references

Owner

olov commented May 6, 2013

This Gist has moved to a GitHub project for easier collaboration. Get it from https://github.com/olov/jekyll-references

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment