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

Kramdown style links #404

Open
anhari opened this issue Sep 29, 2017 · 1 comment
Open

Kramdown style links #404

anhari opened this issue Sep 29, 2017 · 1 comment

Comments

@anhari
Copy link

anhari commented Sep 29, 2017

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
Copy link
Member

kylef commented Sep 29, 2017

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.

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

No branches or pull requests

2 participants