Vuepress: Asciidoctor.js support

Created on 16 Sep 2019  路  9Comments  路  Source: vuejs/vuepress


Feature request



What problem does this feature solve?

Support for other another popular writing format.
Plus, the out-of-the-box search and multi-language vuepress offers (not offered in other static generators) would work wonders to document OS projects in asciidoc.

What does the proposed API look like?

How should this be implemented in your opinion?

I lack the knowledge. But I assume the current engine converts single md files one by one generating the target HTML. I don't it should be easy, but this could be replicated with https://github.com/asciidoctor/asciidoctor.js/ in a similar manner.
I had a look at some vuepress features and:

  • All the features provided by Markdown extension are supported out of the box by Asciidoctor, so users won't miss features.
  • The search-box, afaik indexes titles (H1, H2,...), asciidoctor respects that.
  • Additional Asciidoctor configurations defined in https://vuepress.vuejs.org/guide/markdown.html#advanced-configuration, could also be defined using a similar syntax in an asciidoctor block. Also, asciidoctor. The same native options structure could be used (https://asciidoctor-docs.netlify.com/asciidoctor.js/processor/convert-options/#usage) so that vuepress only passes it.
  • Advanced features would need more work, but are doable.

Are you willing to work on this yourself?

I really cannot due to other commitments and lack of JS expertise, but I am curious to know if you think this could be an option.

low core team review config feature request question or discussion

Most helpful comment

Please, consider using AsciiDoc in VuePress. Thank you.

All 9 comments

I am not familar with ascii doctor.

But It can be a cool feature to have the possibility to have custom transformation.

Interesting but it could be a bit tricky to add it

It would be better have more choice, I hope VuePress supported Asciidoctor too.

Please, consider using AsciiDoc in VuePress. Thank you.

Please add this support.
@kefranabg if you want, we can work on this together 馃槃

I'll discuss this topic with the team and we'll consider adding AsciiDoc support on VP.

For now I don't know what the impacts would be on VuePress core, but we have to make sure it's worth it. For example, if we know that AsciiDoc syntax will be used by 0.5% of VuePress users, we'll probably never implement it.

Is there any update on this? I'd be up for contributing to this if you'd be interested.

I am also interested.

I'm also interested as we use asciidoc to documents all of our development projects (Business stuff Feasibility ,charter ,Software Requirements, etc...) in addition to user guides .

The great thing about AsciiDoc is that it provides, out of the box, most of the things that VuePress currently uses Markdown Extensions for.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

shaodahong picture shaodahong  路  3Comments

gaomd picture gaomd  路  3Comments

tinchox5 picture tinchox5  路  3Comments

ynnelson picture ynnelson  路  3Comments

herrbischoff picture herrbischoff  路  3Comments