all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
From: Thorsten Jolitz <tjolitz@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Add-on: Github Flavored Markdown exporter
Date: Tue, 08 Apr 2014 13:31:13 +0200	[thread overview]
Message-ID: <878urg12im.fsf@gmail.com> (raw)
In-Reply-To: 87a9bwbx6t.fsf@gmail.com

Thorsten Jolitz <tjolitz@gmail.com> writes:

> Lars Tveito <larstvei@student.matnat.uio.no> 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

  reply	other threads:[~2014-04-08 11:30 UTC|newest]

Thread overview: 14+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2014-04-06 21:33 Add-on: Github Flavored Markdown exporter Lars Tveito
2014-04-07 22:18 ` Thorsten Jolitz
2014-04-08 11:31   ` Thorsten Jolitz [this message]
2014-04-08 21:39     ` Lars Tveito
2014-04-09  2:06       ` Grant Rettke
2014-04-09  4:38         ` Nick Dokos
2014-04-09  4:07       ` Charles Berry
2014-04-09  8:32         ` Lars Tveito
2014-04-09  7:03       ` Thorsten Jolitz
2014-04-11 10:29 ` Bastien
2014-04-11 15:57   ` Lars Tveito
2014-06-09 15:50   ` Nicolas Girard
2014-06-09 16:45     ` Bastien
2014-06-09 19:07       ` Nicolas Girard

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

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

  git send-email \
    --in-reply-to=878urg12im.fsf@gmail.com \
    --to=tjolitz@gmail.com \
    --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 external index

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

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.