kakdown

WARNING: This project is very new and experimental. Use at your own risk.

Tools for working with Markdown in Kakoune, including:

Simple live markdown rendering
Easy table formatting

Dependencies

You need the livemd markdown renderer to use the md-preview command.

If you have go installed, just run:

go get github.com/barakmich/livemd

Make sure that $GOPATH/bin is in your $PATH.

Installation

git clone https://github.com/whereswaldon/kakdown
ln -sv $PWD/kakdown/kakdown.kak ~/.config/kak/autoload/

Note: If this is your first time installing a Kakoune plugin and you don't already have a ~/.config/kak/autoload/ folder, I recommend following these steps to create it:

mkdir -p ~/.config/kak/autoload/
ln -sv $(dirname $(which kak))/../share/kak/autoload ~/.config/kak/autoload/system

If you don't symlink the system-wide autoload folder, all of the default Kakoune commands will not be available next time you start your editor.

Commands

All commands are prefixed with md-. From normal mode, type :md- to see the available markdown commands.

Configuration

None is necessary, though you can write hooks to automatically launch previewing when a markdown file is opened.

I also recommend creating a user mapping for the table format command.

Example configuration:

# Register custom hooks whenever I open a markdown file.
# Because the filename filter is a regex, the literal period
# must be escaped
hook global WinSetOption filetype=markdown %{
    # Print in the debug buffer so that I can tell the hook fired
    echo -debug "Markdown Mode Enabled"

    # Automatically launch the preview
    md-preview

    # Create easy user-mode mapping to format tables
    map -docstring "format markdown table under cursor" buffer user t :md-format-table<ret>
}

Todo

Implement previewing multiple documents at the same time
Use a shared livemd process to preview all documents
Implement a way to re-render on idle or when you exit insert mode

Contribute

Feature requests and pull requests welcome!

License

MIT