Skip to content
A light-weight Markdown (CommonMark) previewer for OSX.
Branch: master
Clone or download
Latest commit c6b4d79 Oct 11, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Generator
Markoff.xcodeproj Update to Swift 4 Oct 11, 2018
Markoff
Template Make frontmatter code block style different Feb 10, 2016
.gitignore Add template generator Sep 2, 2015
Cartfile Upgrade to Swift 3 Oct 11, 2018
Cartfile.resolved
LICENSE Update LICENSE Jul 11, 2018
README.md Update README Jul 11, 2018
appstore.svg

README.md

Markoff GitHub release Platform Platform

A light-weight CommonMark previewer for OSX.

  • Uses cmark, a C implementation of CommonMark, for parsing and rendering. This is a lot of faster than other existing Ruby and JavaScript solutions.
  • Allows you to select your default editor and open the previewed document in it by hitting Cmd+e, using the menu item, or clicking the toolbar button.
  • Uses highlight.js for syntax highlighting.
  • Detects YAML frontmatter and renders it as a special code block.
  • Auto-reloads the preview whenever the original file is saved. Depending on your editor, you might be able to set up auto-save to get an always up-to-date preview without manually saving.
  • Shows basic information such word and character count.

Setup

Make sure you have Carthage installed, then run in the project root:

carthage update --platform mac

License

See LICENSE file.

Markoff was initially maintained and funded by thoughtbot, inc.

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.