A modern macOS markdown editor - themeable, tabs, sidebar, github flavored markdown, exporting, latex and more
Branch: master
Clone or download
Latest commit 56840de Feb 23, 2019

README.md

Twig

Swift 4.2 Platform Github Github All Releases

Twig is lightweight macOS markdown editor. It's currently a work in progress.

It is a document based application, and aims to follow Apple's Human Interface Guidelines

Installing

Twig is still in its very early stages, so if you encounter any bugs or have a feature request please raise an issue!

Install via Homebrew Cask

$ brew tap lukakerr/casks
$ brew cask install twig

Manual Download

Visit the releases page to download manually.

Uninstalling

Download via Homebrew Cask

$ brew cask remove twig

Downloaded Manually

$ rm -r /Applications/Twig.app ~/Library/Caches/io.github.lukakerr.twig

Building

To build and run, clone this repository, open in Xcode and hit "Run".

$ git clone git@github.com:lukakerr/twig.git
$ cd twig
$ open Twig.xcworkspace

Contributing

See CONTRIBUTING.md for details on how to contribute.

Features

  • Themeable
  • Math support (LaTeX subset)
  • GitHub Flavored Markdown
  • Local image support
  • Toggleable split view (horizontal and vertical split)
  • Full screen support
  • Tab support
  • Folder support
  • Ability to create custom .css themes
  • Ability to share .md files
  • Syntax highlighting for source and preview
  • Autosaving
  • Version control and history recovery
  • Markdown shortcuts (keyboard and Touch Bar shortcuts)
  • Auto pair markdown tags
  • Custom font
  • Word count

Todo

  • Add ability to edit preview .css
  • Improve sidebar
    • Folder watching
    • More actions in contextual menu

Screenshots