Skip to content

Commit

Permalink
feat(docs): docs for highlight groups (#13)
Browse files Browse the repository at this point in the history 
## Description
Docs for highlight groups. This is my first time dealing with tables in
Markdown. Hope I didn't mess anything up 😛
<!-- Describe the big picture of your changes to communicate to the
maintainers
  why we should accept this pull request. -->

## Related Issue(s)
Closes #8.
<!--
  If this PR fixes any issues, please link to the issue here.
  - Fixes #<issue_number>
-->

## Screenshots

<!-- Add screenshots of the changes if applicable. -->
  • Loading branch information
@dpetka2001
dpetka2001 authored Nov 7, 2024
1 parent 080e0d4 commit 964cd6a
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,3 +183,47 @@ See the example below for how to configure `snacks.nvim`.
```

<!-- example:end -->

## 🌈 Highlight Groups

<details>
<summary>Click to see all highlight groups</summary>

<!-- hl_start -->

| Highlight Group | Default Group | Description |
| -------------------------------------- | -------------------------------- | -------------------------------------------------- |
| **SnacksNormal** | _NormalFloat_ | Normal for the float window |
| **SnacksWinBar** | _Title_ | Title of the window |
| **SnacksBackdrop** | _none_ | Backdrop |
| **SnacksNormalNC** | _NormalFloat_ | Normal for non-current windows |
| **SnacksWinBarNC** | _SnacksWinBar_ | Title for non-current windows |
| **SnacksNotifierInfo** | _none_ | Notification window for Info |
| **SnacksNotifierWarn** | _none_ | Notification window for Warn |
| **SnacksNotifierDebug** | _none_ | Notification window for Debug |
| **SnacksNotifierError** | _none_ | Notification window for Error |
| **SnacksNotifierTrace** | _none_ | Notification window for Trace |
| **SnacksNotifierIconInfo** | _none_ | Icon for Info notification |
| **SnacksNotifierIconWarn** | _none_ | Icon for Warn notification |
| **SnacksNotifierIconDebug** | _none_ | Icon for Debug notification |
| **SnacksNotifierIconError** | _none_ | Icon for Error notification |
| **SnacksNotifierIconTrace** | _none_ | Icon for Trace notification |
| **SnacksNotifierTitleInfo** | _none_ | Title for Info notification |
| **SnacksNotifierTitleWarn** | _none_ | Title for Warn notification |
| **SnacksNotifierTitleDebug** | _none_ | Title for Debug notification |
| **SnacksNotifierTitleError** | _none_ | Title for Error notification |
| **SnacksNotifierTitleTrace** | _none_ | Title for Trace notification |
| **SnacksNotifierBorderInfo** | _none_ | Border for Info notification |
| **SnacksNotifierBorderWarn** | _none_ | Border for Warn notification |
| **SnacksNotifierBorderDebug** | _none_ | Border for Debug notification |
| **SnacksNotifierBorderError** | _none_ | Border for Error notification |
| **SnacksNotifierBorderTrace** | _none_ | Border for Trace notification |
| **SnacksNotifierFooterInfo** | _DiagnosticInfo_ | Footer for Info notification |
| **SnacksNotifierFooterWarn** | _DiagnosticWarn_ | Footer for Warn notification |
| **SnacksNotifierFooterDebug** | _DiagnosticHint_ | Footer for Debug notification |
| **SnacksNotifierFooterError** | _DiagnosticError_ | Footer for Error notification |
| **SnacksNotifierFooterTrace** | _DiagnosticHint_ | Footer for Trace notification |

<!-- hl_end -->

</details>

0 comments on commit 964cd6a

Please sign in to comment.