Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ray-x/yamlmatter.nvim
Enhancing the display of YAML frontmatter in Markdown files
https://github.com/ray-x/yamlmatter.nvim
frontmatter markdown nvim-lua nvim-plugin nvim-plugins yaml
Last synced: 2 days ago
JSON representation
Enhancing the display of YAML frontmatter in Markdown files
- Host: GitHub
- URL: https://github.com/ray-x/yamlmatter.nvim
- Owner: ray-x
- Created: 2024-09-18T02:10:09.000Z (9 days ago)
- Default Branch: master
- Last Pushed: 2024-09-22T03:05:50.000Z (5 days ago)
- Last Synced: 2024-09-24T02:04:13.456Z (3 days ago)
- Topics: frontmatter, markdown, nvim-lua, nvim-plugin, nvim-plugins, yaml
- Language: Lua
- Homepage:
- Size: 6.84 KB
- Stars: 23
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# yamlmatter.nvim
Enhancing the display of YAML front matter in Markdown files
## WIP
Instead see this in markdown file
```markdown
---
title: algebra
author: ray
date: 2024-05-05
id: 1714834956
tags:
- algebra
- math
category: note
type: post
---
```
You see this:
```markdown
title algebra
author ray
date 2024-05-05
id 1714834956
tags { 'algebra', 'math' }
category note
type post
```
## Prerequisites
- Neovim 0.9+
- nvim-treesitter for markdown and yaml
- A patched font with Nerd Font glyphs
## Configuration
```lua
require('yamlmatter').setup({
icon_mappings = {
title = '',
idea = '',
default = '',
},
highlight_groups = {
icon = 'MyIconHighlight',
key = 'MyKeyHighlight',
value = 'MyValueHighlight',
},
key_value_padding = 4, -- Less space
conceallevel = 1, -- on what level start conceal the yaml text
})
```
## Commands
By default if plugin setup, you can use `:YamlMatter` to toggle the display of YAML front matter and use
`:YamlMatterDisable` to disable it.
## License
This plugin is licensed under the MIT License.