From mboxrd@z Thu Jan 1 00:00:00 1970 From: Thorsten Jolitz Subject: Re: Add-on: Github Flavored Markdown exporter Date: Tue, 08 Apr 2014 13:31:13 +0200 Message-ID: <878urg12im.fsf@gmail.com> References: <87a9bwbx6t.fsf@gmail.com> Mime-Version: 1.0 Content-Type: text/plain Return-path: Received: from eggs.gnu.org ([2001:4830:134:3::10]:46318) by lists.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WXUE8-0003bT-Od for emacs-orgmode@gnu.org; Tue, 08 Apr 2014 07:30:09 -0400 Received: from Debian-exim by eggs.gnu.org with spam-scanned (Exim 4.71) (envelope-from ) id 1WXUE3-0004Kf-K6 for emacs-orgmode@gnu.org; Tue, 08 Apr 2014 07:30:04 -0400 Received: from plane.gmane.org ([80.91.229.3]:49063) by eggs.gnu.org with esmtp (Exim 4.71) (envelope-from ) id 1WXUE3-0004K6-E7 for emacs-orgmode@gnu.org; Tue, 08 Apr 2014 07:29:59 -0400 Received: from list by plane.gmane.org with local (Exim 4.69) (envelope-from ) id 1WXUE1-0006iw-GX for emacs-orgmode@gnu.org; Tue, 08 Apr 2014 13:29:57 +0200 Received: from g231235076.adsl.alicedsl.de ([92.231.235.76]) by main.gmane.org with esmtp (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 08 Apr 2014 13:29:57 +0200 Received: from tjolitz by g231235076.adsl.alicedsl.de with local (Gmexim 0.1 (Debian)) id 1AlnuQ-0007hv-00 for ; Tue, 08 Apr 2014 13:29:57 +0200 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: emacs-orgmode@gnu.org Thorsten Jolitz writes: > Lars Tveito writes: > >> Hi! >> >> I have written an exporter for Github Flavored Markdown, which is a >> derived back-end from the Markdown (vanilla) exporter. It adds >> Github-style src-blocks, strike-through and table of contents. Your library works really good, thanks. I would recommend adding it to /contrib. I used it to create new README.md files for all three libraries navi-mode.el, outorg.el and outshine.el, you can find the repos on github.com/tj64 if you want to take a look. I like the idea very much to write this documentation stuff once in one place and then reuse it in all other places. Therefore when I write a source file, I use outorg to write a more or less sophisticated comment header for that file. This is then automatically converted back to a programming language comment section, but I can always convert it back to Org-mode. From the outorg-edit-buffer, I can then export it to html, latex, ascii and now to markdown-github-flavor too, whats nice. I use a little trick to do this: I narrow the buffer to the first 1st level headline, and then use ,-------------- | C-1 M-# M-# | C-u 1 M-# M-# `-------------- to temporarily insert the default export template, or ,-------------- | C-3 M-# M-# | C-u 3 M-# M-# `-------------- to temporarily insert a custom export template from a file. A few questions and remarks: - I get the best results with just using example blocks - is it supposed to work with source-blocks and other blocks too? - Just like the Org exporter in general, it does not know how to deal with boxes made with rebox2.el, so I replaced them with example blocks. - What about numbered lists with longer text/blocks as item content - is the item numbering supposed to work? -- cheers, Thorsten