Skip to content

Commit

Permalink
docs: added showcase for integrations
Browse files Browse the repository at this point in the history
  • Loading branch information
dasupradyumna committed Jun 15, 2023
1 parent e76baf3 commit e780f40
Show file tree
Hide file tree
Showing 27 changed files with 86 additions and 21 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,12 @@ on maintaining a comfortable level of color contrast for a pleasant visual exper

## Showcase

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

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

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

## Vision

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

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

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

## Contributing

I encourage fellow contributors to submit PRs if they wish to fix a bug or add a feature.
I encourage fellow contributors to submit PRs if they wish to fix a bug or add a plugin.
Since I cannot feasibly test out every single possibility, I would love it if contributors can help
in improving the documentation especially for other package managers.
I would also like help with LSP and treesitter groups for languages that have not been covered.
Expand Down
1 change: 1 addition & 0 deletions lua/midnight/highlight/plugin/diffview.lua
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@ return {
DiffviewFilePanelDeletions = { link = 'GitDeleted' },
DiffviewFilePanelConflicts = { link = 'GitMerge' },
DiffviewFolderSign = { link = 'NvimTreeFolderIcon' },
DiffviewDiffDelete = { link = 'Comment' },
}
3 changes: 3 additions & 0 deletions lua/midnight/highlight/plugin/gitsigns.lua
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,8 @@ return {
GitSignsAdd = { link = 'GitNew' },
GitSignsChange = { link = 'GitDirty' },
GitSignsDelete = { link = 'GitDeleted' },
GitSignsAddInline = { link = 'DiffAdd' },
GitSignsChangeInline = { link = 'DiffText' },
GitSignsDeleteInline = { link = 'DiffDelete' },
GitSignsCurrentLineBlame = { link = 'Whitespace' },
}
4 changes: 2 additions & 2 deletions lua/midnight/highlight/plugin/mason.lua
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,6 @@ return {
MasonHighlightBlockBold = { link = 'MasonHeader' },
MasonHighlightBlockBoldSecondary = { link = 'MasonHeader' },
MasonMuted = { fg = c.comment },
MasonMutedBlock = { bg = c.bg },
MasonMutedBlockBold = { bg = c.bg, style = 'bold' },
MasonMutedBlock = { fg = c.fg },
MasonMutedBlockBold = { fg = c.fg, style = 'bold' },
}
27 changes: 13 additions & 14 deletions lua/midnight/highlight/semantic/neorg.lua
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ return {
['@neorg.headings.3.prefix'] = { link = '@neorg.headings.1.prefix' },
['@neorg.headings.4.prefix'] = { link = '@neorg.headings.1.prefix' },
['@neorg.headings.5.prefix'] = { link = '@neorg.headings.1.prefix' },
-- ['@neorg.headings.6.prefix'] = { link = '@neorg.headings.1.prefix' },
['@neorg.headings.6.prefix'] = { clear = true },
['@neorg.headings.6.prefix'] = { link = '@neorg.headings.1.prefix' },
['@neorg.headings.1.title.norg'] = { link = '@neorg.headings.1.prefix' },
['@neorg.headings.2.title.norg'] = { link = '@neorg.headings.2.prefix' },
['@neorg.headings.3.title.norg'] = { link = '@neorg.headings.3.prefix' },
Expand Down Expand Up @@ -58,22 +57,13 @@ return {
['@neorg.links.location.heading.6.norg'] = { link = 'NeorgLinkComponent' },
['@neorg.links.location.url.norg'] = { link = 'NeorgLinkURL' },

['@neorg.lists.ordered.1.prefix.norg'] = { link = 'Parameter' },
['@neorg.lists.ordered.2.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
['@neorg.lists.ordered.3.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
['@neorg.lists.ordered.4.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
['@neorg.lists.ordered.5.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
['@neorg.lists.ordered.6.prefix.norg'] = { link = '@neorg.lists.ordered.1.prefix.norg' },
['@neorg.lists.unordered.1.prefix.norg'] = { link = 'Parameter' },
['@neorg.lists.unordered.2.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
['@neorg.lists.unordered.3.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
['@neorg.lists.unordered.4.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
['@neorg.lists.unordered.5.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
['@neorg.lists.unordered.6.prefix.norg'] = { link = '@neorg.lists.unordered.1.prefix.norg' },
['@neorg.lists.ordered.prefix.norg'] = { link = 'Parameter' },
['@neorg.lists.unordered.prefix.norg'] = { link = 'Parameter' },

['@neorg.markup.bold.norg'] = { link = 'Bold' },
['@neorg.markup.italic.norg'] = { link = 'Italic' },
['@neorg.markup.underline.norg'] = { link = 'Underlined' },
['@neorg.markup.spoiler.norg'] = { fg = c.comment },
['@neorg.markup.strikethrough.norg'] = { link = 'Strikethrough' },
['@neorg.markup.inline_comment.norg'] = { link = 'Comment' },
['@neorg.markup.verbatim.norg'] = { fg = c.operator, bg = p.gray[10] },
Expand All @@ -94,8 +84,17 @@ return {
['@neorg.tags.ranged_verbatim.code_block'] = { bg = p.gray[10] },
['@neorg.tags.ranged_verbatim.document_meta.categories.norg_meta'] = { link = 'Operator' },
['@neorg.tags.ranged_verbatim.document_meta.description.norg_meta'] = { fg = p.gray[4] },
['@neorg.tags.ranged_verbatim.document_meta.string.norg_meta'] = { link = 'String' },
['@neorg.tags.ranged_verbatim.document_meta.key.norg_meta'] = { fg = c.comment },
['@neorg.tags.ranged_verbatim.document_meta.value.norg_meta'] = { link = 'Field' },
['@neorg.tags.ranged_verbatim.parameters.norg'] = { link = 'Field' },
['@neorg.tags.ranged_verbatim.parameters.word.norg'] = { link = 'Field' },

['@neorg.todo_items.cancelled.norg'] = { fg = c.comment },
['@neorg.todo_items.done.norg'] = { fg = c.success },
['@neorg.todo_items.on_hold.norg'] = { fg = c.variable },
['@neorg.todo_items.urgent.norg'] = { fg = c.warn },
['@neorg.todo_items.pending.norg'] = { fg = c.method },
['@neorg.todo_items.recurring.norg'] = { fg = c.keyword },
['@neorg.todo_items.undone.norg'] = { fg = c.error },
}
60 changes: 60 additions & 0 deletions showcase/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Showcase

### General

![Main 1](main1.png "main_1")
![Main 2](main2.png "main_2")

Colorscheme showcase for integrated plugins:

- [lazy.nvim](#lazynvim)
- [mason.nvim](#masonnvim)
- [diffview.nvim](#diffviewnvim)
- [nvim-dap-ui](#nvim-dap-ui)
- [telescope.nvim](#telescopenvim)
- [nvim-tree.lua & todo-comments.nvim](#nvim-treelua--todo-commentsnvim)
- [nvim-lspconfig](#nvim-lspconfig)
- [neorg](#neorg)

### lazy.nvim

![Main/Install/Clean](integrations/lazy/main_install_clean.jpg "main_install_clean")
![Update/Sync/Check/Restore](integrations/lazy/update_sync_check_restore.jpg "update_sync_check_restore")
![Log](integrations/lazy/log.jpg "log")
![Profile](integrations/lazy/profile.jpg "profile")
![Debug](integrations/lazy/debug.jpg "debug")
![Help](integrations/lazy/help.jpg "help")

### mason.nvim

![Main](integrations/mason/main.jpg "main")
![Help](integrations/mason/help.jpg "help")

### diffview.nvim

![Status Diff](integrations/diffview/status_diff.jpg "status_diff")
![Status Merge](integrations/diffview/status_merge.jpg "status_merge")
![Git History](integrations/diffview/history.jpg "history")

### nvim-dap-ui

![DAP UI](integrations/dapui.jpg "dapui")

### telescope.nvim

![Telescope](integrations/telescope.jpg "telescope")

### nvim-tree.lua & todo-comments.nvim

![Tree and TODO](integrations/nvimtree_todocomments.jpg "tree_todo")

### nvim-lspconfig

![LSPInfo](integrations/lspconfig.jpg "lspinfo")

### neorg

![Sample 1](integrations/neorg/sample1.png "sample_1")
![Sample 2](integrations/neorg/sample2.png "sample_2")
![Sample 3](integrations/neorg/sample3.png "sample_3")
![Sample 4](integrations/neorg/sample4.png "sample_4")
Binary file added showcase/integrations/dapui.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/diffview/history.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/diffview/status_diff.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/diffview/status_merge.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/lazy/debug.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/lazy/help.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/lazy/log.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/lazy/profile.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/lspconfig.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/mason/help.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/mason/main.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/neorg/sample1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/neorg/sample2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/neorg/sample3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/neorg/sample4.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/nvimtree_todocomments.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added showcase/integrations/telescope.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes

0 comments on commit e780f40

Please sign in to comment.