Is there a command line utility for rendering GitHub flavored Markdown?

by

I wrote a small CLI in Python and added GFM support. It’s called Grip (Github Readme Instant Preview).

Install it with:

$ pip install grip

And to use it, simply:

$ grip

Then visit localhost:5000 to view the readme.md file at that location.

You can also specify your own file:

$ grip CHANGES.md

And change port:

$ grip 8080

And of course, specifically render GitHub-Flavored Markdown, optionally with repository context:

$ grip --gfm --context=username/repo issue.md

Notable features:

  • Renders pages to appear exactly like on GitHub
  • Fenced blocks
  • Python API
  • Navigate between linked files (thanks, vladwing!) added in 2.0
  • Export to a single file (thanks, iliggio!) added in 2.0
  • New: Read from stdin and export to stdout added in 3.0

Hope this helps someone here. Check it out.

More Related Contents:

  1. How to add images to README.md on GitHub?
  2. GitHub relative link in Markdown file
  3. How to use sed to replace only the first occurrence in a file?
  4. What is a faster alternative to Python’s http.server (or SimpleHTTPServer)?
  5. How to pass command line argument to gnuplot?
  6. How do you input command line arguments in IntelliJ IDEA?
  7. How to check in command-line if a given file or directory is locked (used by any process)?
  8. Why is my command prompt freezing on Windows 10?
  9. How to check if ping responded or not in a batch file
  10. How to add color to GitHub’s README.md file
  11. How to suppress specific MSBuild warning
  12. Encoding a readable movie by QuickTime using FFMPEG
  13. How to use command line arguments in Fortran?
  14. How to show math equations in general github’s markdown(not github’s blog)
  15. xcopy file, rename, suppress “Does xxx specify a file name…” message
  16. Command prompt won’t change directory to another drive
  17. How to pass argument to Makefile from command line?
  18. Adding command line options to CMake
  19. How to script FTP upload and download
  20. Get certificate fingerprint of HTTPS server from command line?
  21. Latex rendering in README.md on Github
  22. Updates were rejected because the tip of your current branch is behind hint: its remote counterpart. Integrate the remote changes (e.g [duplicate]
  23. wmic error (invalid XSL format) in windows7
  24. Is it possible to accept custom command line parameters with Inno Setup
  25. How can I embed a YouTube video on GitHub wiki pages?
  26. How to embed a video into GitHub README.md?
  27. How can I wrap my markdown in an HTML div?
  28. Using command line arguments in VBscript
  29. dos batch iterate through a delimited string
  30. find filenames NOT ending in specific extensions on Unix?

Leave a Comment