https://github.com/nathom/mdwrap

A markdown formatter
https://github.com/nathom/mdwrap

Last synced: about 1 month ago
JSON representation

A markdown formatter

• Host: GitHub
• URL: https://github.com/nathom/mdwrap
• Owner: nathom
• Created: 2023-03-01T19:01:43.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-24T09:19:54.000Z (11 months ago)
• Last Synced: 2025-02-13T04:44:01.597Z (3 months ago)
• Language: Rust
• Size: 41 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# mdwrap

A small Rust program that wraps markdown files. Uses the

[comrak](https://docs.rs/comrak/) AST library so that rendering

remains accurate.

## Usage

Write wrapped input.md to output.md.

``` bash

mdwrap -f input.md -o output.md

```

Write wrapped markdown from stdin to stdout

``` bash

mdwrap

```

### Use with (neo)vim

As a vim command

``` vimscript

%!mdwrap

```

With [formatter.nvim](https://github.com/mhartington/formatter.nvim)

and lazy.nvim (plugin manager).

``` lua

local function wrapper()

	return {

		exe = "mdwrap",

		args = { "-l", "70" }, -- or whatever line width you want

		stdin = true,

	}

end

return {

	"mhartington/formatter.nvim",

	config = function(plugin)

		local formatter_setup = {

			logging = false,

			filetype = {

				markdown = { wrapper },

			},

		}

		require("formatter").setup(formatter_setup)

	end,

	cmd = "FormatWrite",

 }

```