emacs-orgmode@gnu.org archives
 help / color / mirror / code / Atom feed
* Exporting .org to .md for Sourcehut (sr.ht); ox-md not following Markdown spec?
@ 2020-12-02 18:52 TRS-80
  2020-12-02 19:12 ` Jean Louis
                   ` (3 more replies)
  0 siblings, 4 replies; 12+ messages in thread
From: TRS-80 @ 2020-12-02 18:52 UTC (permalink / raw)
  To: emacs-orgmode

Hallo,

I became quite interested in what Drew Devault was doing with his
Sourcehut project, so I decided to join.  I was really enjoying
everything except for the fact that .org files are not supported insofar
as automatic rendering into nice looking HTML in the same way that
Markdown files are for the README at the root of the project.  And the
official word is that only Markdown is to be supported.[0]

So I start digging into this, my first try was to use
org-md-export-to-markdown function to generate the supported Markdown.
However, doing it that way broke all inter-page links (to headings,
footnotes, etc.).

Some further digging revealed that the ox-md exporter (which itself is
derived from the HTML exporter(?) makes extensive use of the id
attribute in links.  And Sourcehut's HTML sanitizer only allows href and
title attributes (not id).[1]

For example, here are the sort of links that the ox-md exporter create:

ToC:

```
1.  [rofi-in-elisp](#orgdbf2274)
```

Body:

```
<a id="orgdbf2274"></a>

# rofi-in-elisp
```

Above was copied straight from Eli Schwartz reply to me in my post to
Sourcehut mailing list about this[0] (although I had already noticed the
same thing as well).

I tend to agree with him that this is not following the Markdown spec,
where links should instead become simply:

ToC:

```
1.  [rofi-in-elisp](#rofi-in-elisp)
```

And if so, then the Right Thing to do would be to fix that in the ox-md
exporter?

However OTOH, I can't help but venture a guess that there must have been
some reason to do it that way in the first place.

So before I invest any more time going down this path, I thought I would
take a step back and seek some advice whether this is actually the
correct path or not?

Cheers,
TRS-80

[0] 
https://lists.sr.ht/~sircmpwn/sr.ht-discuss/%3Cfe7aa296-9c90-463d-b4e6-50eeb7e57428%40localhost%3E
[1] https://man.sr.ht/markdown/#post-processing


^ permalink raw reply	[flat|nested] 12+ messages in thread

end of thread, other threads:[~2020-12-11 16:05 UTC | newest]

Thread overview: 12+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2020-12-02 18:52 Exporting .org to .md for Sourcehut (sr.ht); ox-md not following Markdown spec? TRS-80
2020-12-02 19:12 ` Jean Louis
2020-12-02 19:56   ` TRS-80
2020-12-02 21:32     ` TRS-80
2020-12-02 19:44 ` Tim Cross
2020-12-02 20:44   ` TRS-80
2020-12-02 21:59     ` Tim Cross
2020-12-02 23:17       ` TRS-80
2020-12-02 23:36         ` Tim Cross
2020-12-02 19:45 ` Diego Zamboni
2020-12-02 20:25   ` TRS-80
2020-12-11 15:53 ` TRS-80

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