MarkEdit CLI Tool

MarkEdit is native Markdown text editor for MacOs. It has a gorgeous interface with a simple feature set. Letting you write content that humans will understand rather than a machine compiler. This repo is a CLI tool/interface that lets you interact with MarkEdit.

Written in Typescript with Deno.

And its easy as hell to use:

$ markdwn ./your_file.md

opens MarkEdit with your_file.md

Features

• CLI Tool
• Ultra customizable to your own needs since this is written in Typescript.

Installation

Install Deno

This step is only required if you don’t already have deno installed. Follow the guide here or run either of these commands (MacOs):

$ curl -fsSL https://deno.land/x/install/install.sh | sh
or via brew
brew install deno

Installing the CLI

1. Clone repo git clone git@github.com:First-Derivative/MarkEdit-cli.git
2. Run deno task install which compiles markedit.ts into an executable markdwn in $HOME/.deno/bin/ (the default DENO_INSTALL_ROOT)
3. Ensure the directory $HOME/.deno/bin/ is exported to your PATH

Exporting deno to your path

Update your .bashrc or .zshrc file to include your deno install paths to your PATH. To do so, add this line to your .bashrc or .zshrc export PATH=“/$HOME/.deno/bin:$PATH"

Or run this command:
(if using .bashrc)

echo 'export PATH="$HOME/.deno/bin:$PATH"' >> ~/.bashrc

(if using .zshrc)

echo 'export PATH="$HOME/.deno/bin:$PATH"' >> ~/.zshrc

Customization

If you would like to access the cli via some command other than markdwn then you just need rename the output of the compilation for the install task in deno.json

// demo.json 
{
  "tasks": {
 	...
    "install": "deno install --allow-run -f -n {{COMMAND_NAME}} markedit.ts"
  }
}

Contribution

If you are having issues, or would like some extra functionality feel free to create an Issue/Pull Request I will also take any queries on ashraff.hatz@gmail.com

Planned Features

2. Create file on no file found
3. Command that initializes README.md with template and opens it with MarkEdit