https://github.com/dnebauer/dn-markdown.nvim

Auxiliary filetype plugin for markdown
https://github.com/dnebauer/dn-markdown.nvim

Last synced: about 2 months ago
JSON representation

Auxiliary filetype plugin for markdown

• Host: GitHub
• URL: https://github.com/dnebauer/dn-markdown.nvim
• Owner: dnebauer
• Created: 2024-01-27T01:12:15.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2024-06-05T13:13:48.000Z (7 months ago)
• Last Synced: 2024-08-02T18:36:59.411Z (5 months ago)
• Language: Lua
• Size: 27.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• my-neovim-pluginlist - dnebauer/dn-markdown.nvim - markdown.nvim)   (Editing support / Parenthetical edit)

README

        
# dn-markdown.nvim

An auxiliary filetype plugin for the markdown language.

The plugin author uses the

[vim-pandoc](https://github.com/vim-pandoc/vim-pandoc) plugin and

[pander](https://github.com/dnebauer/pander) for markdown support. This plugin

is intended to address gaps in markdown support provided by those tools.

## Dependencies

Pandoc is used to generate output. It is not provided by this ftplugin. This ftplugin depends on the [vim-pandoc](https://github.com/vim-pandoc/vim-pandoc) plugin and assumes [pander](https://github.com/dnebauer/pander) is installed.

This plugin depends on the [dn-utils.nvim](https://github.com/dnebauer/dn-utils.nvim) plugin.

## Features

A default [pander](https://github.com/dnebauer/pander)- and pandoc-compatible yaml-style metadata block can be added to a markdown file.

A helper function, mapping and command are provided to assist with adding figures. They assume the images are defined using reference links with optional attributes, and that all reference links are added to the end of the document prefixed with three spaces.

This plugin leaves the bulk of output generation to [vim-pandoc](https://github.com/vim-pandoc/vim-pandoc). In addition, this plugin provides a mapping, command and function for deleting output files and temporary output directories. Read the help file carefully before using this feature as it is potentially unsafe. By default, when buffers are deleted or vim exits, the user has an opportunity to delete output files/directories.

## License

This plugin is distributed under the GNU GPL version 3.