emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tom Regner <tom@goochesa.de>
To: emacs-orgmode@gnu.org
Subject: Re: README.org on github
Date: Sat, 19 May 2012 11:23:17 +0200	[thread overview]
Message-ID: <87sjetwue7.fsf@goochesa.de> (raw)
In-Reply-To: <87likoaai6.fsf@gnu.org> (Bastien's message of "Sat, 19 May 2012 09:35:45 +0200")


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

  reply	other threads:[~2012-05-21 13:12 UTC|newest]

Thread overview: 20+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2012-05-18 18:45 README.org on github Rainer M Krug
2012-05-19  7:35 ` Bastien
2012-05-19  9:23   ` Tom Regner [this message]
2012-08-03 18:19     ` Bastien
2012-08-04  3:23       ` Waldemar Quevedo
2012-08-04  7:15         ` Bastien
2012-05-21  8:38   ` Rainer M Krug
2012-05-21  8:57     ` Puneeth Chaganti
2012-05-21  9:02       ` Rainer M Krug
2012-05-21  9:57         ` Puneeth Chaganti
2012-05-21 10:05           ` Rainer M Krug
2012-05-21 12:43       ` suvayu ali
2012-05-21 13:29         ` Tom Regner
2012-05-22 15:54           ` suvayu ali
2012-05-22 16:02             ` Puneeth Chaganti
2012-05-22 23:19               ` Bastien
2012-05-22 23:16             ` Bastien
2012-05-20  4:03 ` François Pinard
2012-05-20 22:05   ` Neil Smithline
2012-05-21  8:43     ` Rainer M Krug

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

  List information: https://www.orgmode.org/

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=87sjetwue7.fsf@goochesa.de \
    --to=tom@goochesa.de \
    --cc=emacs-orgmode@gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).