seagle0128 / grip-mode

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

GitHub API what for? #26

Closed buhtz closed 1 year ago

buhtz commented 1 year ago

Hi,

from your README it is not clear for me why your application can use GitHub API. For what? It is a markdown editor. It is totally unclear how GitHub can help here. What is the feature behind it?

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

Kind Christian ox-gfm

seagle0128 commented 1 year ago

Please refer to https://github.com/joeyespo/grip.

Grip is a command-line server application written in Python that uses the GitHub markdown API to render a local readme file. The styles and rendering come directly from GitHub, so you'll know exactly how it will appear. Changes you make to the Readme will be instantly reflected in the browser without requiring a page refresh.

buhtz commented 1 year ago

Again. Two sentences would have been enough.

This is also a security issue. Do grip or your package do send the markdown to the Microsoft GitHub servers? In that case there should be big fat warning about it.

seagle0128 commented 1 year ago

Your question is to grip, I think. grip-mode is just a wrapper, no guarantees for security issue of grip.