Re: README.org on github

[Tom Regner <tom@goochesa.de>]

Note: Resend to the list; I did send this mail to bastien alone, not the
list - mea culpa.


Hi,

Bastien <bzg@gnu.org> writes:

> Hi Rainer,
>
> Rainer M Krug <r.m.krug@gmail.com> writes:
>
>> I would like to use a README.org file on github, and also include code
>> blocks in the README.org - is this possible?
>
> No.

It depends - org-ruby in versions starting with 0.6 is at least a bit
more capable -- the version used with github-markup is quite old, as far
as I can tell; you won't get syntax highlighting, but better recognition
of org-blocks of different kind - you can install it as a ruby gem and
experiment a little on your local machine.

I installed github/markup locally and changed the Gemfile to enforce
versions from 0.6.0 upward -- at least my zshrc.org[fn:2] looked a lot better
processed with newer versions.

>
>> What do I have to do to achieve this? The help on
>> https://github.com/github/markup sounds kryptic to me.
>
> The thing to do would be to improve org-ruby¹, which is used 
> to convert README.org into HTML.
>
> Please contact org-ruby's author or github people for this.

Maybe you could make yourself heard in the issue I opened [fn:1]; it is
actually the third issue I opened, I never got a response and closed the
other ones -- maybe my conclusions are wrong, and an update of org-ruby
wouldn't help (that much) -- but with more people actually requesting
better org-support, maybe it will get a bit more attention and progress.

kine regards,
Tom
>
> ¹ https://github.com/bdewey/org-ruby

[fn:1] https://github.com/github/markup/issues/117

[fn:2] https://github.com/tomterl/zshorg/blob/master/zshrc.org