From: Rainer M Krug <R.M.Krug@gmail.com>
To: emacs-orgmode@gnu.org
Cc: "François Pinard" <pinard@iro.umontreal.ca>
Subject: Re: README.org on github
Date: Mon, 21 May 2012 10:43:41 +0200 [thread overview]
Message-ID: <4FBA003D.9090804@gmail.com> (raw)
In-Reply-To: <4FB96A8C.4060704@neilsmithline.com>
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On 21/05/12 00:05, Neil Smithline wrote:
> I've been looking at this too. I go with Bastien. Work with me to improve org-ruby gem or
> export to HTML before pushing to Git.
Hi Neil,
Unfortunately I know nothing about ruby and it would have been a "nice to have" for me - So I'll
try the html route or for the time being stick with a simpler README.org file.
Cheers,
Rainer
>
> Neil Smithline http://www.neilsmithline.com Proud GNU Emacs user since 1986, v. 18.24.
>
> On Sun May 20 00:03:12 2012, François Pinard wrote:
>> 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?
>>
>> Hi, Rainer. I'm not sure I'm really replying to your request, but nevertheless hope my
>> comments might be useful.
>>
>> Having recently had a similar need, I gave into the following compromise: I push README.md
>> (in Markdown format) on GitHub, but maintain my real sources as README.org (well, under a
>> different name) at home. Directly quoting from the README.md file on GitHub:
>>
>> I currently much enjoy Org format for handling my own notes, and do not feel like switching
>> to Markdown for original sources. So, README.md gets derived automatically from the Org
>> source.
>>
>> Some of my Org notes are private, and even for the public ones, there are :noexport:
>> sections. Because of these private parts, I do not make my Org sources directly available.
>> Nodemacs.org becomes an HTML file through the Org publishing feature, and that HTML file is
>> later turned into a Markdown file using the impressive Pandoc tool. Climbing from generated
>> HTML back to the structural intent is not a trivial job in my opinion. Not only Pandoc did
>> it well, it was blazing fast at it. Moreover, as it is written in Haskell, it scratches on
>> my prejudice of Haskell being essentially an academical language!
>>
>> Pandoc is an installable package on the Ubuntu system I use, so very easy to install. To
>> use, I added a Makefile containing:
>>
>> --8<---------------cut here---------------start------------->8--- # Internal goals
>>
>> README.md: ~/fp/web/notes/Nodemacs.html pandoc -o $@ $^ --8<---------------cut
>> here---------------end--------------->8---
>>
>> to the project. The script which regularly synchronizes my projects from home to GitHub
>> executes "make" in each project before pushing, this ensures for this one that README.md is
>> up to date.
>>
>> I did not experiment with code blocks however, and cannot say how well or bad it works.
>>
>> François
>>
>> P.S. - Before Pandoc, I tried "w3m -dump", which yielded something a little too flat for my
>> taste. I also tried the generic exporter with Markdown parametrization, which did not
>> produce a usable enough result.
>>
>
>
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.11 (GNU/Linux)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/
iEYEARECAAYFAk+6AD0ACgkQoYgNqgF2egoU6QCdE1/kNsLZwDKPRFZoHXGcwzi7
9wcAni6cq16IdJy/J0UYuNNgFRpVu9iJ
=z4NF
-----END PGP SIGNATURE-----
prev parent reply other threads:[~2012-05-21 8:45 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
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 [this message]
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=4FBA003D.9090804@gmail.com \
--to=r.m.krug@gmail.com \
--cc=emacs-orgmode@gnu.org \
--cc=pinard@iro.umontreal.ca \
/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).