Skip to content
Browse files

Updated README

  • Loading branch information...
1 parent 9254f8e commit 6e21430275bf8ebeb847b76504e57716fdce95bb @magnetikonline committed Apr 7, 2013
Showing with 6 additions and 4 deletions.
  1. +6 −4 README.md
View
10 README.md
@@ -1,7 +1,7 @@
# GitHub Markdown render
Display [Markdown](http://github.github.com/github-flavored-markdown/) formatted documents on your local development web server using GitHub's [Markdown Rendering API](http://developer.github.com/v3/markdown/) and CSS to mimic the visual display on GitHub itself.
-Handy for authoring/previewing **README.md** files (or any Markdown for that matter) in project repositories, hopefully avoiding noisy `git push` actions in commit logs due to excessive typos/errors.
+Handy for authoring/previewing `README.md` files (or any Markdown for that matter) in project repositories, hopefully avoiding noisy `git push` actions in commit logs due to excessive typos/errors.
**Note:** this is intended for local development only, probably not a good idea for production use due to GitHub API rate limits per user.
@@ -25,7 +25,7 @@ To view rendered Markdown using the same parsing and styling as GitHub project p
http://localhost/projects/unrarallthefiles/README.md?ghmd
http://localhost/projects/webserverinstall.ubuntu12.04/install.md?ghmd
-Rendered HTML is cached in a PHP session based on **\*.md** modification time to reduce repeated GitHub API calls for the same file content.
+Rendered HTML is cached in a PHP session based on markdown file modification time to reduce repeated GitHub API calls for the same file content.
## Install
@@ -46,7 +46,7 @@ Update the following constants at the top of `index.php` in the `GitHubMarkdownR
</table>
### Setup URL rewrite rules
-Next, setup URL rewrite for your default virtual host so all requests to **/local/path/*.md?ghmd** are rewritten to `/path/to/ghmarkdownrender/index.php`. Refer to the supplied `rewrite.nginx.conf` & `rewrite.apache.conf` for examples.
+Next, setup URL rewrite for your default virtual host so all requests to `/local/path/*.md?ghmd` are rewritten to `/path/to/ghmarkdownrender/index.php`. Refer to the supplied `rewrite.nginx.conf` & `rewrite.apache.conf` for examples.
**Note:**
- You may want to have requested raw Markdown files (e.g. `http://localhost/projects/ghmarkdownrender/README.md`) served up with a MIME type such as `text/plain` for convenience.
@@ -57,4 +57,6 @@ Next, setup URL rewrite for your default virtual host so all requests to **/loca
You should now be able to call a Markdown document with a querystring of `?ghmd` to receive a familiar GitHub style Markdown display. The page footer will also display the total/available API rate limits, or if rendering was cached based on file modification time.
## CSS style issues
-Markdown display CSS has been lifted (deliberately) from GitHub.com. It's more than likely there are some CSS styles missing. Would really appreciate any Markdown source examples and/or pull requests to help make things complete.
+Markdown display CSS has been lifted (deliberately) from GitHub.com. It's quite possible/likely there are some CSS styles missing to make this complete.
+
+If anything missing is noted, would really appreciate any Markdown source examples or pull requests to help make things complete.

0 comments on commit 6e21430

Please sign in to comment.
Something went wrong with that request. Please try again.