org mode to github markdown

org mode to github markdown

[Uwe Brauer]

Hi 

I am using very very often org-mime either to edit an message (gnus)
buffer as a org buffer, and then I sometimes export it to html when
needed.

There seems no export backend for (github) markdown

On the other hand I still prefer to reply to github issues via email,
and not editing the web interface

There seems however to (github) markdow exporter (I also checked the
package-list)

Anybody has a suggestion?

Regards

Uwe Brauer 
-- 
Warning: Content may be disturbing to some audiences
I strongly condemn Putin's war of aggression against the Ukraine.
I support to deliver weapons to Ukraine's military. 
I support the ban of Russia from SWIFT.
I support the EU membership of the Ukraine. 
https://addons.thunderbird.net/en-US/thunderbird/addon/gmail-conversation-view/

Re: org mode to github markdown

[Bernt Hansen]

Hi Uwe,

I'm not sure I fully understand your question.
You are looking for an org-mode export to markdown?  Isn't that already included in recent org versions?

C-c C-e C-s m M

Regards,
Bernt

(who has been away from the org-mode mailing list for way too many years...)

On 5/7/23 13:25, Uwe Brauer wrote:
> 
> Hi
> 
> I am using very very often org-mime either to edit an message (gnus)
> buffer as a org buffer, and then I sometimes export it to html when
> needed.
> 
> There seems no export backend for (github) markdown
> 
> On the other hand I still prefer to reply to github issues via email,
> and not editing the web interface
> 
> There seems however to (github) markdow exporter (I also checked the
> package-list)
> 
> Anybody has a suggestion?
> 
> Regards
> 
> Uwe Brauer

Re: org mode to github markdown

[Ihor Radchenko]

Bernt Hansen <bernt@norang.ca> writes:

> (who has been away from the org-mode mailing list for way too many years...)

Welcome back. Your GTD config got me started with Org years back :)

> I'm not sure I fully understand your question.
> You are looking for an org-mode export to markdown?  Isn't that already included in recent org versions?
>
> C-c C-e C-s m M

Markdown is not a single standard. There are several variations of the
syntax. See https://en.wikipedia.org/wiki/Markdown

We support the most basic "vanilla" markdown in ox-md.el. But Github
uses its own flavour, which we do not export to. In particular, vanilla
markdown allow direct HTML fragments, which are disabled in
GitHub/Reddit/many other websites for security reasons. Instead, they
invent new markdown constructs that are explicitly supported. But there
are numerous Markdown syntax extensions - it is hard to support them
unless we have a dedicated maintainer.

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: org mode to github markdown

[Ihor Radchenko]

Uwe Brauer <oub@mat.ucm.es> writes:

> There seems however to (github) markdow exporter (I also checked the
> package-list)
>
> Anybody has a suggestion?

ox-pandoc

-- 
Ihor Radchenko // yantar92,
Org mode contributor,
Learn more about Org mode at <https://orgmode.org/>.
Support Org development at <https://liberapay.com/org-mode>,
or support my work at <https://liberapay.com/yantar92>

Re: org mode to github markdown

[Uwe Brauer]

[-- Attachment #1: Type: text/plain, Size: 759 bytes --]

>>> "IR" == Ihor Radchenko <yantar92@posteo.net> writes:

> Uwe Brauer <oub@mat.ucm.es> writes:
>> There seems however to (github) markdow exporter (I also checked the
>> package-list)
>> 
>> Anybody has a suggestion?

> ox-pandoc

Ok, thanks but I meant including it in email, that is import org syntax
to github md before sending the mail (like org-mime but not html instead
github markdown)


-- 
Warning: Content may be disturbing to some audiences
I strongly condemn Putin's war of aggression against the Ukraine.
I support to deliver weapons to Ukraine's military. 
I support the ban of Russia from SWIFT.
I support the EU membership of the Ukraine. 
https://addons.thunderbird.net/en-US/thunderbird/addon/gmail-conversation-view/

[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]

Re: org mode to github markdown

[Max Nikulin]

On 08/05/2023 02:45, Ihor Radchenko wrote:
> In particular, vanilla
> markdown allow direct HTML fragments, which are disabled in
> GitHub/Reddit/many other websites for security reasons.

GitHub allows some HTML tags. I have noticed e.g. floating <img> and 
<details> collapsed fragments in
https://github.com/org-roam/org-roam/blob/main/README.md
see
https://github.com/org-roam/org-roam/blob/main/README.md?plain=1

P.S. GitHub allows raw <img> in .org files as well:
https://github.com/alphapapa/org-ql/blob/master/README.org?plain=1

Re: org mode to github markdown

[Ruijie Yu via General discussions about Org-mode.]

Uwe Brauer <oub@mat.ucm.es> writes:

> There seems no export backend for (github) markdown

I think you are looking for "ox-gfm".

I can find it via [search engine] and on melpa.

-- 
Best,


RY

Re: org mode to github markdown

[Uwe Brauer]

[-- Attachment #1: Type: text/plain, Size: 1123 bytes --]

>>> "MN" == Max Nikulin <manikulin@gmail.com> writes:

> On 08/05/2023 02:45, Ihor Radchenko wrote:
>> In particular, vanilla
>> markdown allow direct HTML fragments, which are disabled in
>> GitHub/Reddit/many other websites for security reasons.

> GitHub allows some HTML tags. I have noticed e.g. floating <img> and
> <details> collapsed fragments in
> https://github.com/org-roam/org-roam/blob/main/README.md
> see
> https://github.com/org-roam/org-roam/blob/main/README.md?plain=1

But enumerated or bullet list, bold, underline and italics and  more
importantly source code follow a different markup syntax, isn't



> P.S. GitHub allows raw <img> in .org files as well:
> https://github.com/alphapapa/org-ql/blob/master/README.org?plain=1




-- 
Warning: Content may be disturbing to some audiences
I strongly condemn Putin's war of aggression against the Ukraine.
I support to deliver weapons to Ukraine's military. 
I support the ban of Russia from SWIFT.
I support the EU membership of the Ukraine. 
https://addons.thunderbird.net/en-US/thunderbird/addon/gmail-conversation-view/

[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]

[ox-gfm] (was: org mode to github markdown)

[Uwe Brauer]

[-- Attachment #1: Type: text/plain, Size: 1058 bytes --]

>>> "GdaO" == General discussions about Org-mode <Ruijie> writes:

> Uwe Brauer <oub@mat.ucm.es> writes:

>> There seems no export backend for (github) markdown

> I think you are looking for "ox-gfm".

Thanks, I realized this is an important pkg for my purpose (although I
have to see how it can be included in my email export)

But also I can run the function org-gfm-export-as-markdown directly, I
would like to include this exporter directly in the usual
org-export-dispatch but I don't now how, there is now repository or
webapge for this package, and also no email address of the author

Anybody has an idea how to incldue ox-gfm into the org-export-dispatch?

Thanks

Uwe Brauer 

-- 
Warning: Content may be disturbing to some audiences
I strongly condemn Putin's war of aggression against the Ukraine.
I support to deliver weapons to Ukraine's military. 
I support the ban of Russia from SWIFT.
I support the EU membership of the Ukraine. 
https://addons.thunderbird.net/en-US/thunderbird/addon/gmail-conversation-view/

[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]

Re: [ox-gfm] (was: org mode to github markdown)

[Bhavin Gandhi]

On Mon, 8 May 2023 at 18:35, Uwe Brauer <oub@mat.ucm.es> wrote:
>
> >>> "GdaO" == General discussions about Org-mode <Ruijie> writes:
>
> > Uwe Brauer <oub@mat.ucm.es> writes:
>
> >> There seems no export backend for (github) markdown
>
> > I think you are looking for "ox-gfm".
>
> Thanks, I realized this is an important pkg for my purpose (although I
> have to see how it can be included in my email export)
>
> But also I can run the function org-gfm-export-as-markdown directly, I
> would like to include this exporter directly in the usual
> org-export-dispatch but I don't now how, there is now repository or
> webapge for this package, and also no email address of the author

I think this is the package we are referring to?
https://github.com/larstvei/ox-gfm
https://list.orgmode.org/m2eh1adtye.fsf@ifi.uio.no/

> Anybody has an idea how to incldue ox-gfm into the org-export-dispatch?

The README says loading ox-gfm adds it to the org-export-dispatch, I
tried doing (require 'ox-gfm) and it started showing up. But I don't
know if there is any other/better way to do that.

-- 
Bhavin Gandhi (bhavin192) | https://geeksocket.in

Re: [ox-gfm]

[Uwe Brauer]

[-- Attachment #1: Type: text/plain, Size: 1017 bytes --]


> On Mon, 8 May 2023 at 18:35, Uwe Brauer <oub@mat.ucm.es> wrote:

> I think this is the package we are referring to?
> https://github.com/larstvei/ox-gfm

Thanks very much
> https://list.orgmode.org/m2eh1adtye.fsf@ifi.uio.no/


> The README says loading ox-gfm adds it to the org-export-dispatch, I
> tried doing (require 'ox-gfm) and it started showing up. But I don't
> know if there is any other/better way to do that.

Indeed, the require call is need. 

Sigh: the package system sometimes confuses me because the functions
provided by ox-gfm were already available after installation, without
the require command.

Anyhow thanks very much

-- 
Warning: Content may be disturbing to some audiences
I strongly condemn Putin's war of aggression against the Ukraine.
I support to deliver weapons to Ukraine's military. 
I support the ban of Russia from SWIFT.
I support the EU membership of the Ukraine. 
https://addons.thunderbird.net/en-US/thunderbird/addon/gmail-conversation-view/

[-- Attachment #2: smime.p7s --]
[-- Type: application/pkcs7-signature, Size: 5673 bytes --]

Re: [ox-gfm]

[Corwin Brust]

On Tue, May 9, 2023 at 6:10 AM Uwe Brauer <oub@mat.ucm.es> wrote:
>
> > The README says loading ox-gfm adds it to the org-export-dispatch, I
> > tried doing (require 'ox-gfm) and it started showing up. But I don't
> > know if there is any other/better way to do that.
>
> Indeed, the require call is need.
>
> Sigh: the package system sometimes confuses me because the functions
> provided by ox-gfm were already available after installation, without
> the require command.
>

FWIW, I believe installing the package (at least, via package.el) will
load it (as a side effect?).