readme_renderer icon indicating copy to clipboard operation
readme_renderer copied to clipboard

Published 20 hours ago • verified publisher icon pypa

Orgmode support

Open davidam opened this issue 6 years ago • 3 comments

Hello,

It would be nice add orgmode support. You can find orgmode parsers in https://orgmode.org/worg/org-tools/index.html

Thanks.

davidam avatar Oct 30 '19 11:10 davidam

Hello! Circling back to this, and I was curious about the expected workflow here. Is it common for Org mode users to write README-style files for projects and leave them in Org mode, or would it make more sense to export the Org mode document into the desired format, like RST? https://github.com/msnoigrs/ox-rst

miketheman avatar Aug 21 '22 11:08 miketheman

Orgmode did start to write TODO.org files, but it was evolving to many things, people write wikis, blogs or static web sites, articles, manual or papers with orgmode. They write README files, too. I have been being user of orgmode and I find easy remember the orgmode sintaxis and would be nice can write the README files in orgmode.

davidam avatar Aug 21 '22 12:08 davidam

What help is needed for this in particular? I can do this.

@miketheman Org is used in the Emacs editor to do all things office-related and note-taking related. It is trivial to support a subset of Org for the purpose of rendering README.org, that's what GitHub and GitLab do.

createyourpersonalaccount avatar Jul 30 '24 19:07 createyourpersonalaccount