search

seagle0128 / grip-mode

Instant Github-flavored Markdown/Org preview using grip
GNU General Public License v3.0
269 stars 6 forks source link

Explain "ox-gfm" #25

Closed buhtz closed 1 year ago

buhtz commented 1 year ago

Hi,

from your README it is not clear for me what ox-gfm is, what for do I need it and how to setup it up and connect it with your package.

Maybe you can improve your README/FAQ with that info.

Kind Christian

seagle0128 commented 1 year ago

Please see the link: https://github.com/larstvei/ox-gfm.

buhtz commented 1 year ago

Of course I looked there. It is not clear for me what it is or how it is connected to your package. Simply two sentences from your site would be nice to your users.

seagle0128 commented 1 year ago

Instant Github-flavored Markdown/Org preview using Grip (GitHub Readme Instant Preview). ox-gfm is optional, but it brings better rendering for org files.

grip-mode supports to render both org and md files. For org files, it will be exported to md via ox-md or ox-gfm, and then be rendered by grip. ox-gfm is optional, since ox-md is built-in. I don't think it's neccessary to broadcast to all users. All details are in the codes.