From mboxrd@z Thu Jan 1 00:00:00 1970 From: Neil Smithline Subject: Re: README.org on github Date: Sun, 20 May 2012 18:05:00 -0400 Message-ID: <4FB96A8C.4060704@neilsmithline.com> References: <4FB698BC.9040602@gmail.com> <86vcjra48v.fsf@mercure.progiciels-bpi.ca> Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8; format=flowed Content-Transfer-Encoding: 8bit Return-path: Received: from eggs.gnu.org ([208.118.235.92]:49446) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SWEFQ-0007Tt-OB for emacs-orgmode@gnu.org; Sun, 20 May 2012 18:05:10 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1SWEFN-0008RA-KE for emacs-orgmode@gnu.org; Sun, 20 May 2012 18:05:08 -0400 Received: from mail-qa0-f48.google.com ([209.85.216.48]:46669) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1SWEFN-0008Mh-G9 for emacs-orgmode@gnu.org; Sun, 20 May 2012 18:05:05 -0400 Received: by qady23 with SMTP id y23so1590501qad.14 for ; Sun, 20 May 2012 15:05:03 -0700 (PDT) In-Reply-To: <86vcjra48v.fsf@mercure.progiciels-bpi.ca> List-Id: "General discussions about Org-mode." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org Sender: emacs-orgmode-bounces+geo-emacs-orgmode=m.gmane.org@gnu.org To: =?UTF-8?B?RnJhbsOnb2lzIFBpbmFyZA==?= Cc: emacs-orgmode@gnu.org 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. 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 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. >