emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
From: Tim Cross <theophilusx@gmail.com>
To: emacs-orgmode@gnu.org
Subject: Re: Elegant way to export org to Markdown ?
Date: Sat, 02 Oct 2021 17:44:06 +1000	[thread overview]
Message-ID: <878rzbhnog.fsf@gmail.com> (raw)
In-Reply-To: <03D77FFE-6631-44E1-A77B-F074588AAB3B@traduction-libre.org>


Jean-Christophe Helary <lists@traduction-libre.org> writes:

> I'm trying to work with SourceHut (sr.ht) and right now they only accept Markdown syntax for their readme/wiki files.
>
> Since I work in Emacs/org-mode to write my documents (and try to stick to that),
> I'd like to know if there is an elegant way to export org syntax to MarkDown.
>
> I was thinking that the export-dispatch had an option for Plain Text / Markdown, but that doesn't seem to be the case.
>
> As a workaround, I thought I'd work on a README.org file that I export to HTML,
> change the name to .md and edit the contents to reduce the markup to the strict
> minimum... But when I saw the contents of the HTML, I thought that would be way
> too much work.
>
> *BUT* MarkDown bien basically HTML *without* the head/body tags, it seems to me
> that the HTML export-dispatch thing could have a "super simplified MD
> compatible" HTML option...
>
> Either way, I need a method to export to something that sr.ht will recognize and process as MD so:
>
> 1) is there an external "approved" process to convert org-mode syntaxt to an MD-compatible format ?
> 2) if no, what is the not too hard way to hack the HTML output to produce what I need with export-dispatch ?
>

Org does have an exporter for markdown. You need to enable it (see the
manual).

Note that 'markdown' is a somewhat generic term - there is no 'standard'
for markdown. This means that the markdown generated by org may not be
the same syntax as the markdown supported by sourceHut. A similar issue
exists with github and as a result, there is also an external package
which can add github flavoured markdown to org.

If sourceHut markdown is not the same as org's markdown or the github
flavored markdown, it may be necessary to write a sourceHut flavored
markdown exporter (probably fairly easy to do using the existing ox-md
as a starting point). 


  parent reply	other threads:[~2021-10-02  7:49 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2021-10-02  5:20 Elegant way to export org to Markdown ? Jean-Christophe Helary
2021-10-02  5:55 ` Ihor Radchenko
2021-10-02  5:57 ` Protesilaos Stavrou
2021-10-02  6:10   ` Jean-Christophe Helary
2021-10-02  6:24     ` Ihor Radchenko
2021-10-02  6:32       ` Jean-Christophe Helary
2021-10-02  7:00         ` Ihor Radchenko
2021-10-02  7:34           ` Jean-Christophe Helary
2021-10-02  7:44 ` Tim Cross [this message]
2021-10-02  9:10   ` Jean-Christophe Helary
2021-10-02 12:18 ` Morgan Willcock
2021-10-02 13:31   ` Jean-Christophe Helary
2021-10-03  4:11 ` [emacs-humanities] " Jean-Christophe Helary

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=878rzbhnog.fsf@gmail.com \
    --to=theophilusx@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 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).