Skip to content

Commit e780f40

Browse files
committed
docs: added showcase for integrations
1 parent e76baf3 commit e780f40

27 files changed

+86
-21
lines changed

README.md

+7-5
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ on maintaining a comfortable level of color contrast for a pleasant visual exper
55

66
## Showcase
77

8-
![Sample 1](showcase/sample1.png "Sample 1")
8+
![Main 1](showcase/main1.png "main_1")
99

10-
---
10+
![Main 2](showcase/main2.png "main_2")
1111

12-
![Sample 2](showcase/sample2.png "Sample 2")
12+
More screenshots can be found in the [showcase](showcase) folder, if you want to know what you'll be
13+
getting from this theme.
1314

1415
## Vision
1516

@@ -38,7 +39,7 @@ appearance will not change as a whole.***
3839
- Darker shades of gray for non-critical UI elements such as separators to reduce distraction
3940
- Consistent usage of the palette across plugins and neovim builtins to provide a unified IDE-like
4041
appearance
41-
- Warmer colors for multiple language syntax groups to attract attention intuitively in dense code
42+
- Warmer colors for language syntax groups to attract attention intuitively in dense code
4243
files
4344

4445
#### Integrations
@@ -67,6 +68,7 @@ Install the colorscheme using the package manager that you love!
6768
-- LazySpec (plugin specification)
6869
-- return {
6970
{ 'dasupradyumna/midnight.nvim', lazy = false, priority = 1000 }
71+
-- `lazy` and `priority` are only needed if this is your primary colorscheme to load it first
7072
-- }
7173
```
7274

@@ -146,7 +148,7 @@ local c = colors.components -- component color palette
146148

147149
## Contributing
148150

149-
I encourage fellow contributors to submit PRs if they wish to fix a bug or add a feature.
151+
I encourage fellow contributors to submit PRs if they wish to fix a bug or add a plugin.
150152
Since I cannot feasibly test out every single possibility, I would love it if contributors can help
151153
in improving the documentation especially for other package managers.
152154
I would also like help with LSP and treesitter groups for languages that have not been covered.

lua/midnight/highlight/plugin/diffview.lua

+1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,5 @@ return {
2222
DiffviewFilePanelDeletions = { link = 'GitDeleted' },
2323
DiffviewFilePanelConflicts = { link = 'GitMerge' },
2424
DiffviewFolderSign = { link = 'NvimTreeFolderIcon' },
25+
DiffviewDiffDelete = { link = 'Comment' },
2526
}

lua/midnight/highlight/plugin/gitsigns.lua

+3
Original file line numberDiff line numberDiff line change
@@ -4,5 +4,8 @@ return {
44
GitSignsAdd = { link = 'GitNew' },
55
GitSignsChange = { link = 'GitDirty' },
66
GitSignsDelete = { link = 'GitDeleted' },
7+
GitSignsAddInline = { link = 'DiffAdd' },
8+
GitSignsChangeInline = { link = 'DiffText' },
9+
GitSignsDeleteInline = { link = 'DiffDelete' },
710
GitSignsCurrentLineBlame = { link = 'Whitespace' },
811
}

lua/midnight/highlight/plugin/mason.lua

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,6 @@ return {
1313
MasonHighlightBlockBold = { link = 'MasonHeader' },
1414
MasonHighlightBlockBoldSecondary = { link = 'MasonHeader' },
1515
MasonMuted = { fg = c.comment },
16-
MasonMutedBlock = { bg = c.bg },
17-
MasonMutedBlockBold = { bg = c.bg, style = 'bold' },
16+
MasonMutedBlock = { fg = c.fg },
17+
MasonMutedBlockBold = { fg = c.fg, style = 'bold' },
1818
}

lua/midnight/highlight/semantic/neorg.lua

+13-14
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ return {
2424
['@neorg.headings.3.prefix'] = { link = '@neorg.headings.1.prefix' },
2525
['@neorg.headings.4.prefix'] = { link = '@neorg.headings.1.prefix' },
2626
['@neorg.headings.5.prefix'] = { link = '@neorg.headings.1.prefix' },
27-
-- ['@neorg.headings.6.prefix'] = { link = '@neorg.headings.1.prefix' },
28-
['@neorg.headings.6.prefix'] = { clear = true },
27+
['@neorg.headings.6.prefix'] = { link = '@neorg.headings.1.prefix' },
2928
['@neorg.headings.1.title.norg'] = { link = '@neorg.headings.1.prefix' },
3029
['@neorg.headings.2.title.norg'] = { link = '@neorg.headings.2.prefix' },
3130
['@neorg.headings.3.title.norg'] = { link = '@neorg.headings.3.prefix' },
@@ -58,22 +57,13 @@ return {
5857
['@neorg.links.location.heading.6.norg'] = { link = 'NeorgLinkComponent' },
5958
['@neorg.links.location.url.norg'] = { link = 'NeorgLinkURL' },
6059

61-
['@neorg.lists.ordered.1.prefix.norg'] = { link = 'Parameter' },
62-
['@neorg.lists.ordered.2.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
63-
['@neorg.lists.ordered.3.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
64-
['@neorg.lists.ordered.4.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
65-
['@neorg.lists.ordered.5.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
66-
['@neorg.lists.ordered.6.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
67-
['@neorg.lists.unordered.1.prefix.norg'] = { link = 'Parameter' },
68-
['@neorg.lists.unordered.2.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
69-
['@neorg.lists.unordered.3.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
70-
['@neorg.lists.unordered.4.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
71-
['@neorg.lists.unordered.5.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
72-
['@neorg.lists.unordered.6.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
60+
['@neorg.lists.ordered.prefix.norg'] = { link = 'Parameter' },
61+
['@neorg.lists.unordered.prefix.norg'] = { link = 'Parameter' },
7362

7463
['@neorg.markup.bold.norg'] = { link = 'Bold' },
7564
['@neorg.markup.italic.norg'] = { link = 'Italic' },
7665
['@neorg.markup.underline.norg'] = { link = 'Underlined' },
66+
['@neorg.markup.spoiler.norg'] = { fg = c.comment },
7767
['@neorg.markup.strikethrough.norg'] = { link = 'Strikethrough' },
7868
['@neorg.markup.inline_comment.norg'] = { link = 'Comment' },
7969
['@neorg.markup.verbatim.norg'] = { fg = c.operator, bg = p.gray[10] },
@@ -94,8 +84,17 @@ return {
9484
['@neorg.tags.ranged_verbatim.code_block'] = { bg = p.gray[10] },
9585
['@neorg.tags.ranged_verbatim.document_meta.categories.norg_meta'] = { link = 'Operator' },
9686
['@neorg.tags.ranged_verbatim.document_meta.description.norg_meta'] = { fg = p.gray[4] },
87+
['@neorg.tags.ranged_verbatim.document_meta.string.norg_meta'] = { link = 'String' },
9788
['@neorg.tags.ranged_verbatim.document_meta.key.norg_meta'] = { fg = c.comment },
9889
['@neorg.tags.ranged_verbatim.document_meta.value.norg_meta'] = { link = 'Field' },
9990
['@neorg.tags.ranged_verbatim.parameters.norg'] = { link = 'Field' },
10091
['@neorg.tags.ranged_verbatim.parameters.word.norg'] = { link = 'Field' },
92+
93+
['@neorg.todo_items.cancelled.norg'] = { fg = c.comment },
94+
['@neorg.todo_items.done.norg'] = { fg = c.success },
95+
['@neorg.todo_items.on_hold.norg'] = { fg = c.variable },
96+
['@neorg.todo_items.urgent.norg'] = { fg = c.warn },
97+
['@neorg.todo_items.pending.norg'] = { fg = c.method },
98+
['@neorg.todo_items.recurring.norg'] = { fg = c.keyword },
99+
['@neorg.todo_items.undone.norg'] = { fg = c.error },
101100
}

showcase/README.md

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# Showcase
2+
3+
### General
4+
5+
![Main 1](main1.png "main_1")
6+
![Main 2](main2.png "main_2")
7+
8+
Colorscheme showcase for integrated plugins:
9+
10+
- [lazy.nvim](#lazynvim)
11+
- [mason.nvim](#masonnvim)
12+
- [diffview.nvim](#diffviewnvim)
13+
- [nvim-dap-ui](#nvim-dap-ui)
14+
- [telescope.nvim](#telescopenvim)
15+
- [nvim-tree.lua & todo-comments.nvim](#nvim-treelua--todo-commentsnvim)
16+
- [nvim-lspconfig](#nvim-lspconfig)
17+
- [neorg](#neorg)
18+
19+
### lazy.nvim
20+
21+
![Main/Install/Clean](integrations/lazy/main_install_clean.jpg "main_install_clean")
22+
![Update/Sync/Check/Restore](integrations/lazy/update_sync_check_restore.jpg "update_sync_check_restore")
23+
![Log](integrations/lazy/log.jpg "log")
24+
![Profile](integrations/lazy/profile.jpg "profile")
25+
![Debug](integrations/lazy/debug.jpg "debug")
26+
![Help](integrations/lazy/help.jpg "help")
27+
28+
### mason.nvim
29+
30+
![Main](integrations/mason/main.jpg "main")
31+
![Help](integrations/mason/help.jpg "help")
32+
33+
### diffview.nvim
34+
35+
![Status Diff](integrations/diffview/status_diff.jpg "status_diff")
36+
![Status Merge](integrations/diffview/status_merge.jpg "status_merge")
37+
![Git History](integrations/diffview/history.jpg "history")
38+
39+
### nvim-dap-ui
40+
41+
![DAP UI](integrations/dapui.jpg "dapui")
42+
43+
### telescope.nvim
44+
45+
![Telescope](integrations/telescope.jpg "telescope")
46+
47+
### nvim-tree.lua & todo-comments.nvim
48+
49+
![Tree and TODO](integrations/nvimtree_todocomments.jpg "tree_todo")
50+
51+
### nvim-lspconfig
52+
53+
![LSPInfo](integrations/lspconfig.jpg "lspinfo")
54+
55+
### neorg
56+
57+
![Sample 1](integrations/neorg/sample1.png "sample_1")
58+
![Sample 2](integrations/neorg/sample2.png "sample_2")
59+
![Sample 3](integrations/neorg/sample3.png "sample_3")
60+
![Sample 4](integrations/neorg/sample4.png "sample_4")

showcase/integrations/dapui.jpg

190 KB
Loading
254 KB
Loading
260 KB
Loading
Loading

showcase/integrations/lazy/debug.jpg

75.8 KB
Loading

showcase/integrations/lazy/help.jpg

107 KB
Loading

showcase/integrations/lazy/log.jpg

144 KB
Loading
Loading
97.9 KB
Loading
Loading

showcase/integrations/lspconfig.jpg

59.7 KB
Loading

showcase/integrations/mason/help.jpg

104 KB
Loading

showcase/integrations/mason/main.jpg

112 KB
Loading
103 KB
Loading
80 KB
Loading
68.5 KB
Loading
103 KB
Loading
55.4 KB
Loading

showcase/integrations/telescope.jpg

203 KB
Loading
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)