repository·master·Indexed 26 days ago
https://github.com/macdownapp/macdownAn open source Markdown editor for macOS featuring a split-pane interface for real-time previewing. Documentation covers installation via manual download or Homebrew Cask, development environment setup, and detailed guides on Markdown syntax, rendering preferences, and editor customization. Includes support for Mermaid and Graphviz diagrams, TeX-like math syntax, and custom CSS styling.
To update the GitHub style using the official GitHub style package, you must bump the name in the Makefile and then run the installation and build commands. This process requires npm version 5 or above to utilize package-lock.json.
npm install
npm update primer-markdown
makeYou can install MacDown using one of the following methods:
MacDown.app to your Applications folder.If you use Homebrew, you can install it via the command line:
brew install --cask macdownThe MacDown source code is hosted on GitHub. You can clone the repository to start contributing to the codebase or to review existing issues.
https://github.com/MacDownApp/macdownMacDown supports the original Markdown syntax and allows you to enable or disable various popular non-standard syntaxes.
To join the conversation, ask for help, or find out how to contribute to documentation and support, join the MacDown room on Gitter.
https://gitter.im/MacDownApp/macdownYou can personalize your MacDown experience using the following preference panes:
To build MacDown from source, ensure you have the following requirements installed:
xcode-select --install.After cloning the repository, execute these commands in the repository root to initialize submodules and install dependencies:
git submodule update --initbundle installbundle exec pod installmake -C Dependency/peg-markdown-highlightFinally, open MacDown.xcworkspace in Xcode to begin development.
If you encounter build issues later, try updating the dependencies with:
git submodule update
bundle exec pod installgit submodule update --init
bundle install
bundle exec pod install
make -C Dependency/peg-markdown-highlightMacDown supports Mermaid diagram syntax. You can create Flow Charts, Sequence Diagrams, and Gantt charts by using a mermaid language identifier in your markdown code blocks.
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;If you are not a developer, you can contribute to the project by helping with translations. Use the Transifex project page to add new languages or complete existing translation work.
https://www.transifex.com/macdown/macdown/If you encounter problems or have suggestions for MacDown, you can:
Important: Please search existing issues on GitHub before opening a new one to ensure the problem hasn't already been reported or fixed in the development version.
To use Mermaid or Graphviz diagram rendering in MacDown, you must manually enable them in the application settings:
MacDown.Preferences....Rendering tab.Mermaid and/or Graphviz.