search

apiaryio / api-blueprint

API Blueprint
https://apiblueprint.org
MIT License
8.63k stars 2.14k forks source link

Kramdown style links #404

Open anhari opened 6 years ago

anhari commented 6 years ago

In Kramdown you can define links at the bottom of the document using the syntax shown here:

A [link][kramdown hp] to the homepage.

[kramdown hp]: http://kramdown.gettalong.org "hp"

It doesn’t seem like this is possible in API blueprint, but I thought it could be a nice addition.

kylef commented 6 years ago

Hi @anhari,

That's a great idea. We do use these a lot ourselves in the specification and other documentation. Unfortunately this isn't completely straight forward to implement given how API Blueprint currently works. Each description block is independent and thus the CommonMark parser is only rendering the "title" or "description" blocks without further knowledge about the rest of the documentation.

But none-less, it is possible. We're in the middle of some large refactoring in the parser and once that's done it should free us up to add some newer features.