flink-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Aljoscha Krettek <aljos...@apache.org>
Subject Re: Markdown Engine
Date Wed, 17 Sep 2014 10:21:17 GMT
The Spark Doc uses kramdown without any plugins and they have Scala
highlighting, so it is possible. The tabbing thing is simple
JavaScript.

I think custom plugins would be going a bit overboard. If someone
want's do do it, be my guest, but I'll not the one.

Aljoscha

On Wed, Sep 17, 2014 at 12:00 PM, Ufuk Celebi <uce@apache.org> wrote:
> If I remember correctly, Kramdown only supports syntax highlighters, which
> can't do Scala highlighting. Maybe this has changed or there is a
> highlighter, which works with Scala.
>
> Possible solutions:
> - We could add a markdownify plugin, which introduces explicit markdown
> tags. Those you could use within an HTML block.
> - Anyways I think it would be better to have a custom Jekyll plugin for
> this multi-language code snippets instead of hand-writing the HTML.
>
> On Wed, Sep 17, 2014 at 11:42 AM, Aljoscha Krettek <aljoscha@apache.org>
> wrote:
>
>> Hi,
>> is there any reason why we chose Redcarpet over kramdown as Markdown
>> engine for our Website/Documentation? I'm rewriting the Programming
>> Guide to cover both Java and Scala using Tabs to switch the language.
>> (Similar to this:
>> https://spark.apache.org/docs/latest/programming-guide.html) The
>> problem is now that Redcarpet does not support Markdown inside
>> Block-level elements. I need this because the Code-Specific portions
>> of the guide must be in a <div>. Kramdown, for example supports
>> Markdown inside divs.
>>
>> Cheers,
>> Aljoscha
>>

Mime
View raw message