liujianping/macdown

Open source Markdown editor for OS X.

MacDown

MacDown is an open source Markdown editor for OS X, released under the MIT License. The author stole the idea from Chen Luo’s Mou so that people can make crappy clones.

Visit the project site for more information, or download MacDown.app.zip directly from the latest releases page.

License

MacDown is released under the terms of MIT License. You may find the content of the license here, or inside the LICENSE directory.

You may find full text of licenses about third-party components inside in the LICENSE directory, or the About MacDown panel in the application.

The following editor themes and CSS files are extracted from Mou, courtesy of Chen Luo:

• Mou Fresh Air
• Mou Fresh Air+
• Mou Night
• Mou Night+
• Mou Paper
• Mou Paper+
• Tomorrow
• Tomorrow Blue
• Tomorrow+
• Writer
• Writer+
• Clearness
• Clearness Dark
• GitHub
• GitHub2

Development

If you wish to build MacDown yourself, you will need Git and Cocoapods. After you clone the repository, run the following command inside the repository root (directory containing this README.md file):

git submodule update --init --recursive
pod install

and open MacDown.xcworkspace in Xcode. The first command intialise the dependency submodule(s) used in MacDown; the second one installs dependencies managed by Cocoapods.

Refer to the official guides of Git and Cocoapods if you need more instructions. If you run into build issues later on, try running those commands again to update the dependencies.