Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mikeerickson/open-in-macdown

Open selected markdown file (.md) using Macdown macOS application
https://github.com/mikeerickson/open-in-macdown

Last synced: 15 days ago
JSON representation

Open selected markdown file (.md) using Macdown macOS application

Awesome Lists containing this project

README

        

# open-in-macdown

Open selected markdown file using `macdown` macOS applicatdion.

## Features

Open the command palette and search for open in macdown. (Should only be used on files Macdown can open, which is basically any text file but should be markdown files).

## Requirements

[Macdown - The open source Markdown editor for macOS.](https://macdown.uranusjr.com/)

> MacDown is an open source Markdown editor for macOS, released under the MIT License. It is heavily influenced by Chen Luo’s Mou.

## Extension Settings

This extension provides the following settings:

* `openinmacdown.apppath`: Set the path to your Macdown Application (default is `"/Applications/Macdown.app"`)

## Usage

1. Open your desired markdown file (ie README.md)
2. Select `View | Command Palette...`
3. Type `Open In Macdown`

![Open In Macdown](http://f.cl.ly/items/0X2q2K3q0p1D11001u1M/Screen%20Recording%202018-05-23%20at%2010.16%20AM.gif)

## Known Issues

There are no known issues, but if you find one, please report it to project github page.

[Macdown Issues](https://github.com/mikeerickson/open-in-macdown/issues)

## Release Notes

Initial Release

### 1.0.0

Initial Release

## License

Copyright © 2018 Mike Erickson
Released under the MIT license

## Credits

open-in-macdown written by Mike Erickson

E-Mail: [[email protected]](mailto:[email protected])

Twitter: [@codedungeon](http://twitter.com/codedungeon)

Website: [https://github.com/mikeerickson](https://github.com/mikeerickson)

## Working with Markdown

**Note:** You can author your README using Visual Studio Code. Here are some useful editor keyboard shortcuts:

* Split the editor (`Cmd+\` on macOS or `Ctrl+\` on Windows and Linux)
* Toggle preview (`Shift+CMD+V` on macOS or `Shift+Ctrl+V` on Windows and Linux)
* Press `Ctrl+Space` (Windows, Linux) or `Cmd+Space` (macOS) to see a list of Markdown snippets

### For more information

* [Visual Studio Code's Markdown Support](http://code.visualstudio.com/docs/languages/markdown)
* [Markdown Syntax Reference](https://help.github.com/articles/markdown-basics/)