google / gitiles

A simple browser for Git repositories.
https://gerrit.googlesource.com/gitiles/
Other
582 stars 174 forks source link

Support asciidoc in addition to markdown #131

Closed alonbl closed 6 years ago

alonbl commented 6 years ago

Hi, Asciidoc becomes more popular, it would be very nice if you render it using AsciiDoctor or any similar library. We have pressure to switch, and we will lose the nice browse of gitiles. Thanks!

hanwen commented 6 years ago

asciidoctor shells out to ruby, AFAIK, so it's problematic for use with a Java system.

I think MarkDown is way more popular than AsciiDoc, so I don't see it becoming more popular soon.

alonbl commented 6 years ago

thanks! spring and all derived tools are switching, github already support asciidoc, also the x-doc gerrit plugin has some support, did not check as I prefer the gitiles mode.

paladox commented 6 years ago

Asciidoc is old, Asciidocter is the newer one. Gerrit uses that to generate it's doc.

nattgris commented 6 years ago

I'm not a Java person, but it seems Asciidoctor is supposed to be usable in a JVM:

https://github.com/asciidoctor/asciidoctorj

Also, the conversion can be made client side using Asciidoctor.js...

Would any of these options work for gitiles?

jrn commented 6 years ago

No plans for asciidoc support, for the reasons hanwen mentioned (security implications).

nattgris commented 6 years ago

Sorry, I don't see anyone mentioned security implications, or why they would be different compared to the existing Markdown rendering.

cardil commented 5 years ago

As @paladox and @nattgris said Asciidoctorj is pure JVM implementation. It utilize JRuby to perform it's operations, just look at https://github.com/asciidoctor/asciidoctorj/blob/master/asciidoctorj-core/build.gradle build dependencies.

Many projects are switching to Asciidoctor files because it has superior features. Let's name a few:

That's actually about 99% of most popular libraries in JVM world. @jrn maybe reconsider supporting adoc with Asciidoctorj.

BTW. Even Gerrit uses Asciidoctor documentation: https://gerrit-documentation.storage.googleapis.com/Documentation/3.0.1/index.html :smiley: