https://github.com/honzasladek/typoread

Lightweight framework for web writers
https://github.com/honzasladek/typoread

Last synced: 11 days ago
JSON representation

Lightweight framework for web writers

• Host: GitHub
• URL: https://github.com/honzasladek/typoread
• Owner: honzasladek
• Created: 2010-10-10T09:06:11.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2010-10-10T10:33:35.000Z (about 14 years ago)
• Last Synced: 2024-10-13T14:39:47.770Z (26 days ago)
• Homepage:
• Size: 89.8 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.markdown

Awesome Lists containing this project

README

        
# Typoread

Generate awesome previews of your texts written in MarkDown in one command.

## How to use (for Mac)

1. Install [MarkDown](http://daringfireball.net/projects/markdown/ "MarkDown"), awesome way to write texts by John Gruber.

2. Download my markdown bash script and copy it to some folder you have in your PATH. Make it executable (chmod a+x markdown).

3. You're done.

Now if you finished writing your text, type "markdown filename" (filename is name of your file). It will create HTML file in the same folder and with the same name your text file has. The HTML file also has some styling for reading pleasure. 

Distributed under MIT Licence. Thanks my friend Tomáše Jukin ([@inza](http://www.twitter.com/inza)) for helping me with the bash script.