Grip - TEALSK12/tealsk12.github.io GitHub Wiki

grip is an excellent tool that renders a live preview of your GitHub Markdown content locally as you edit the source. It pulls in all of the styling data directly from GitHub to guarantee a faithful rendering of how your content will look once pushed to GitHub. This tool runs on Windows and Mac OS X.

Links

Installation

If you already have Python installed in your system, installing grip is easy. Launch a command shell and run pip install grip. This should install the Grip package.

Running Grip

To run Grip and view your local GitHub-Flavored Markdown pages, follow these steps:

  1. Launch a command shell window.
  2. CD to the root of your Markdown tree. There should be a README.md file there — this is the starting document that Grip will look for.
  3. On Windows, run start grip. On Mac, grip &.
  4. In your browser, navigate to http://localhost:6419/. You should see the README.md file rendered in your browser.

Working Around The GitHub API Rate Limit

Because grip uses GitHub assets to drive render styles, intensive local editing sessions can hit GitHub's API rate limit. When this happens, your local browser will show an error page instead of your Markdown content. You can fix this using the workaround described in Issue 35.

Windows: Note that once you've generated your GitHub access token following these instructions, you can create the settings.py file in %HOME%\.grip (if you have the environment variable HOME defined) or %USERPROFILE%\.grip.