https://github.com/ikenfin/sublime_github_md

sublime-text-markmon markdown converter bridge.
https://github.com/ikenfin/sublime_github_md

Last synced: about 2 months ago
JSON representation

sublime-text-markmon markdown converter bridge.

• Host: GitHub
• URL: https://github.com/ikenfin/sublime_github_md
• Owner: ikenfin
• Created: 2015-08-18T09:22:49.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-08-26T12:50:22.000Z (over 9 years ago)
• Last Synced: 2023-09-04T06:21:40.420Z (over 1 year ago)
• Language: CSS
• Size: 137 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# github_md.rb

Ruby script to provide bridge to [github-markdown gem](https://rubygems.org/gems/github-markdown) for [Sublime Text 3 - Markmon](https://github.com/yyjhao/sublime-text-markmon) plugin.

**Supported codeblock syntax:**


\`\`\`ruby


require 'redcarpet'


markdown = Redcarpet.new("Hello World!")


puts markdown.to_html


\`\`\`

\`\`\`


\#\!ruby


require 'redcarpet'


markdown = Redcarpet.new("Hello World!")


puts markdown.to_html


\`\`\`

### Attention!

Script adds syntax highlighting feature, but it depends on [GNU Source-highlight](http://www.gnu.org/software/src-highlite/), so for work you must install it.

### Screenshot

![github_md in action](https://dl.dropboxusercontent.com/u/76506086/github/github_md/screens/github_md_screen.png)

### Features

* Syntax highlighting

* Github native markdown parser

### Requirements

* ruby 2.1.2 (maybe works on lower versions)

### Installation

Download and unpack **zip** / clone repo to anywhere you want, for example to `~/scripts/ruby/sublime_github_md/`

Open sublime text 3 Markmon user settings, and configure:

```js

{

    "command" : "ruby /sublime_github_md/github_md.rb",

    "stylesheet" : "/sublime_github_md/css/github.css"

}

```

# Thanks

@yyjhao [sublime-text-markmon](https://github.com/yyjhao/sublime-text-markmon)

@andyferra [github.css](https://gist.github.com/andyferra/2554919)

GitHub, Inc [github-markdown](https://rubygems.org/gems/github-markdown/)

Lorenzo Bettini [GNU Source-highlight](http://www.gnu.org/software/src-highlite/)