Skip to content

Commit

Permalink
fix: Various bug fixes from markview.nvim
Browse files Browse the repository at this point in the history
doc: Added new documentation and tweaked README.md
  • Loading branch information
OXY2DEV committed Aug 11, 2024
1 parent e88ce30 commit 331d5f7
Show file tree
Hide file tree
Showing 9 changed files with 435 additions and 987 deletions.
36 changes: 20 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,28 @@
# Helpview.nvim

A fancy viewer for `vimdoc`/`help` files.

>[!WARNING]
> This plugin is in it's alpha phase. Breaking changes may occur.
<p align="center">
Decorations for <code>vimdoc/help</code> files in Neovim.
</p>

## Features

- Fully customisable `inline elements`. Currently supported elements,
+ tag
+ taglink
+ optionlink
+ keycodes
+ arguments
+ notes(includes `Warning` & `deprecated` too?
+ cosdespan
- Modeline support.
- Code block support with language string(no icons).
- Various heading levels & title support.
- Horizontal rules support.
Helpview provides quite a few features such as,

- Provides decorations for various vimdoc elements such as,
* Titles
* Headings
* Tags
* Tag links
* Option links
* Attributes
* Highlight group name(names surrounded with `$`).
* Horizontal rules
* Code blocks etc.
- Hybrid mode for previewing and editing together.
- Highly performant even on very large files.
- Dynamic highlight groups!

And a lot more to come.

## Requirements

Expand Down
Loading

0 comments on commit 331d5f7

Please sign in to comment.