Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

GitDown is an Air application that provides a simulated live preview of GitHub Flavored Markdown.

branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

About

GitDown is an Air application that provides a simulated live preview of GitHub Flavored Markdown.

Usage

Open

To open a markdown formatted document click on the Select Markdown File button.

Refresh

To view changes that you have made to your document click on the Refresh button. A document refresh will also occur when GitDown regains application focus.

Markdown Cheat Sheet

To view a cheat sheet of markdown syntax click on the Markdown Cheat Sheet button.

Acknowledgement

The styling for this application is modeled after GitHub's UI. The Markdown Cheat Sheet is taken from GitHub's MCS. The markdown processing is handled by tanoku's javascript translation of Upskirt called jsupskirt. Unfortunately all references to the Upskirt library have been removed from GitHub.

License

Creative Commons

This work is licensed under the Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License. To view a copy of this license, visit http://creativecommons.org/licenses/by-nc-sa/3.0/ or send a letter to Creative Commons, 444 Castro Street, Suite 900, Mountain View, California, 94041, USA.

Known Bugs

If a link is clicked where the target is set to self, the apps window will redirect to that web page. Currently there are no controls to reset the app window. You will have to restart the app to exit out of this scenario.


In this implementation of jsupskirt the parsing of the following markdown syntax is not supported and will break the rendering.

Use of multiple Grave accents to encapsulate code blocks is not supported.
```
function foo(){
return "bar";
}
```
Use of multiple Grave accents with language type to encapsulate code blocks is not supported.
```javascript
function foo(){
return "bar";
}
```
Use of <pre> tags is not supported.
<pre>
function foo(){
return "bar";
}
</pre>
Use of <code> tags is not supported.
<code>
function foo(){
return "bar";
}
</code>
Something went wrong with that request. Please try again.