emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* org 2 gfm markdown and back again
@ 2018-11-06  9:14 Divan Santana
  0 siblings, 0 replies; only message in thread
From: Divan Santana @ 2018-11-06  9:14 UTC (permalink / raw)
  To: emacs-orgmode; +Cc: Pierre Neidhardt

Hi fellow people :)

So like a lot of you, I'd love to write all my documentation in orgmode.

However I work with gitlab flavoured markdown a lot in our environment.
Wishfully one can convert easily between orgmode and markdown and back
again.

Therefore I need to be able to convert easily back and forth between the
two formats.

There are some issues with this and wondering what your experiences are
with this (for those that are interested)?

I wrote about this situation briefly in my blog on plain text
documentation.

 [1] https://divansantana.com/plain-text-documentation/index.html

pandoc orgmode support is not good enough at converting orgmode to
markdown and back again.

For example converting this org file[2] to markdown with pandoc does
not result in this properly formatted gfm markdown file[3].

 [2] https://gitlab.com/ambrevar/ambrevar.gitlab.io/blob/master/source/guix-packaging/index.org
 [3] https://git.savannah.gnu.org/cgit/guix/guix-artwork.git/tree/website/posts/packaging-tutorial.md

Using the various ~org-md-~ functions from ~ox-md.el~ is better. However
it only supports org2markdown, not the reverse.  Furthermore, it still
doesn't do a perfect job with the conversation.

Pierre Neidhardt wrote a nice wrapper which improves the org2markdown
export[4].

 [4] https://gitlab.com/ambrevar/ambrevar.gitlab.io/blob/master/source/guix-packaging/org2md.el

The result works very well in my testing.  However this still doesn't
solve the markdown2org situation.

Anyone thought of something box to improve this situation?
--
Divan Santana
https://divansantana.com

^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2018-11-06  9:30 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2018-11-06  9:14 org 2 gfm markdown and back again Divan Santana

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).