vim-markdownfmt

KO | EN

gitlite — search

#python #ai #go #android #machine-learning #deep-learning #linux #macos #java #windows #awesome #awesome-list #pytorch #open-source

vim-markdownfmt

(★ 34)

Markdown formatting plugin for Vim

vim-markdownfmt Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

vim-markdownfmt
===============

Markdown formatting plugin for Vim. Designed to work with "gofmt-style" commands such as [markdownfmt](https://github.com/shurcooL/markdownfmt) and [mdfmt](https://github.com/moorereason/mdfmt).

Installation
------------

### Vundle

If you use [Vundle](https://github.com/gmarik/vundle), add the following to your `vimrc`:

```vim
Plugin 'moorereason/vim-markdownfmt'
```

Then install with:

```vim
:PluginInstall
```

### Pathogen

If you use [Pathogen](https://github.com/tpope/vim-pathogen), do this:

```sh
cd ~/.vim/bundle
git clone https://github.com/moorereason/vim-markdownfmt.git
```

Options
-------

### Command Executable

Define which "fmt" executable you want to use. It must be in your PATH. Default is `markdownfmt`.

```vim
let g:markdownfmt_command = 'markdownfmt'
```

### Command Options

Define options to be passed to command executable. Default is empty. Note that `-w` is *always* passed as an option.

```vim
let g:markdownfmt_options = ''
```

### Autosave

Set whether to automatically run format command on save. Default is `0`.

```vim
let g:markdownfmt_autosave=0
```

### Fail Silently

Set whether to fail silently (1) or show errors (0). Default is 0 (show errors).

```vim
let g:markdownfmt_fail_silently=0
```

Key Bindings
------------

If you decide to leave the autosave feature disabled, you can use a command like the following to format and save the current buffer.

```vim
au FileType markdown nmap <leader>s :<C-u>call markdownfmt#Format()<CR>
```

Credits
-------

-	The Go Authors for their `gofmt` Vim plugin.
-	[vim-go Contributors](https://github.com/fatih/vim-go/graphs/contributors) for inspiration.
-	[Contributors](https://github.com/moorereason/vim-markdownfmt/graphs/contributors) of vim-markdownfmt.

License
-------

MIT License. See file `LICENSE` for more details.

vim-markdownfmt

vim-markdownfmt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

vim-markdownfmt

vim-markdownfmt Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README