vuepress icon indicating copy to clipboard operation
vuepress copied to clipboard

Asciidoctor.js support

Open abelsromero opened this issue 5 years ago • 14 comments

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.

abelsromero avatar Sep 16 '19 18:09 abelsromero

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

flozero avatar Sep 19 '19 20:09 flozero

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

MasterShu avatar Oct 10 '19 08:10 MasterShu

Please, consider using AsciiDoc in VuePress. Thank you.

CanadianBeaver avatar Oct 26 '19 00:10 CanadianBeaver

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

jabby avatar Feb 03 '20 16:02 jabby

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.

kefranabg avatar Feb 03 '20 17:02 kefranabg

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

LukasHirt avatar Mar 15 '20 13:03 LukasHirt

I am also interested.

hortonelectric avatar Mar 22 '20 12:03 hortonelectric

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 .

alialjowaher avatar Apr 11 '20 21:04 alialjowaher

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

kevinlang avatar May 29 '20 23:05 kevinlang

It's going to be 2 years very soon since this issue has been opened. What's the status on this one? It's a no-brainer that asciidoc is far superior to markdown. Currently, Antora is the only tool that support technical writing using asciidoc.

imperialguy avatar Jul 02 '21 15:07 imperialguy

Any plan for this yet? Asciidoctor is the only decent markup format honestly. Without it I can't switch to Vuepress, and would really like to.

RichardJECooke avatar Aug 03 '21 07:08 RichardJECooke

also interested in this feature

bcardellini avatar Aug 22 '23 18:08 bcardellini

我也对这个功能感兴趣,希望可以支持

bongxin avatar May 14 '24 04:05 bongxin

+1

endurox-dev avatar May 31 '24 15:05 endurox-dev