Skip to content

Instantly share code, notes, and snippets.

@justincbagley
Last active August 12, 2021 00:27
Show Gist options
  • Save justincbagley/f2dc179ed62c32d28983847e0ad97ff1 to your computer and use it in GitHub Desktop.
Save justincbagley/f2dc179ed62c32d28983847e0ad97ff1 to your computer and use it in GitHub Desktop.
The Markdown Rendering Quest Continues

The Markdown Rendering Quest Continues

GitHub Markdown

Everyone loves GitHub-flavored Markdown. A problem of interest for some time now is rendering, editing, and saving Markdown with GitHub rendering style.

This is something that has interested me since at least 2018. Indeed, I have been using grip for Markdown preview, conversion, and saving to PDF on macOS for years, as I detailed previously in one of my other popular Gists here.

Problem: GitHub API Limits

However, lately, I've started running into GitHub API limits. I even had issues with this with grip when I passed my user id and password with grip using the --user and --pass flags, respectively, but this still did not overcome the GitHub limits. Of course, I found this quite interrupting of my flow (no one wants to wait an hour to be able to continuously update the rendering of an open file again), so I looked into other options.

Solution: Atom

I learned that Atom has a nice Markdown preview package built in now (available by default, and on GitHub here). So, my current approach is to build my GitHub-flavored Markdown document in Atom with the preview function running, then to do a 'final' run with grip and save as PDF from my browser window (e.g. Safari).

Other Recent Failed Attempts:

glow

Of note, I also tried glow. It is cool but not as nice looking and doesn't really seem to work well for my purposes, so I can't recommend it.

editR

Additionally, I tried the editR R package with poor results. I could get the shiny app to run but I could not get it to correctly display my markdown, so I cannot recommend it.

Hope this helps someone.

~J

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment