Inter-document cross references in Jekyll

Previous Topic Next Topic
 
classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

Inter-document cross references in Jekyll

Peppe
Hi!

We're building a documentation site with Jekyll and AsciiDoc. It contains up to a hundred pages categorised with folders. The documents refer quite a bit to each other by links. I'm having with setting up said links. Referencing with <<document#header,text to show>> works good as long as both files are in the same folder, but if document is in another folder, it just outputs the command as plaintext.

So for example this:
Reference to another file: <<another-document#intro.background,In the same folder>>
Reference to another folder: <<../third-document#intro.goals,In another folder>>

Here the first line produces a link, correctly, while the other one outputs the source AD directly.

Is this how it is supposed to work? Is this the best way to handle links within Jekyll? We'd like to be able to use standard Asciidoc annotations instead of Jekyll ones as we will also produce docbook and pdf from the same Asciidoc source files.

Thanks,
Jens Jansson
Vaadin Ltd.

Reply | Threaded
Open this post in threaded view
|

Re: Inter-document cross references in Jekyll

mojavelinux
Administrator
Jens,

The issue you are looking for is here:


It has been fixed in master and waiting on the 1.5.3 release.

-Dan

On Fri, Jun 26, 2015 at 4:03 AM, Peppe [via Asciidoctor :: Discussion] <[hidden email]> wrote:
Hi!

We're building a documentation site with Jekyll and AsciiDoc. It contains up to a hundred pages categorised with folders. The documents refer quite a bit to each other by links. I'm having with setting up said links. Referencing with <<document#header,text to show>> works good as long as both files are in the same folder, but if document is in another folder, it just outputs the command as plaintext.

So for example this:
Reference to another file: <<another-document#intro.background,In the same folder>>
Reference to another folder: <<../third-document#intro.goals,In another folder>>

Here the first line produces a link, correctly, while the other one outputs the source AD directly.

Is this how it is supposed to work? Is this the best way to handle links within Jekyll? We'd like to be able to use standard Asciidoc annotations instead of Jekyll ones as we will also produce docbook and pdf from the same Asciidoc source files.

Thanks,
Jens Jansson
Vaadin Ltd.




If you reply to this email, your message will be added to the discussion below:
http://discuss.asciidoctor.org/Inter-document-cross-references-in-Jekyll-tp3444.html
To start a new topic under Asciidoctor :: Discussion, email [hidden email]
To unsubscribe from Asciidoctor :: Discussion, click here.
NAML



--
Reply | Threaded
Open this post in threaded view
|

Re: Inter-document cross references in Jekyll

Peppe
Awesome!

We'll try this fix and see how it goes.

Thanks Dan