Skip to content

Commit

Permalink
Docs: Update maintainer and plugins note (#133)
Browse files Browse the repository at this point in the history 
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
@AlexvZyl @github-actions
AlexvZyl and github-actions[bot] authored Apr 14, 2024
1 parent d7829b8 commit 03fcff3
Show file tree
Hide file tree
Showing 7 changed files with 84 additions and 114 deletions.
6 changes: 1 addition & 5 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,6 @@ A Neovim colorscheme based on [Nord](https://www.nordtheme.com/), but Aurora > F

If there is anything that does not seem right, even if it is a very small highlight, please let me know with an issue or PR!

#### 💡 Looking for Maintainers

Currently looking for maintainers. If you are keen, head on over to [the discussion](https://github.com/AlexvZyl/nordic.nvim/discussions/96).

# 📷 Showcase

![image](https://github.com/AlexvZyl/nordic.nvim/assets/81622310/2437fc89-733a-4368-b418-88cfe804d5d3)
Expand Down Expand Up @@ -154,7 +150,7 @@ require 'nordic' .setup {

# 🗒️ Supported Plugins and Platforms

For the list of supported plugins, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/lua/nordic/groups/integrations). For the list of supported platforms, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms).
For the list of supported plugins, please take a look at [this file](https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/groups/integrations.lua). For the list of supported platforms, please take a look at [this directory](https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms).

I do not personally use all of the platforms and plugins in the list, so if something is not right, or you have a suggestion, please open a PR!

Expand Down
15 changes: 5 additions & 10 deletions doc/nordic.nvim.txt
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*nordic.nvim.txt* For NVIM v0.8.0 Last change: 2024 February 08
*nordic.nvim.txt* For NVIM v0.8.0 Last change: 2024 April 14

==============================================================================
Table of Contents *nordic.nvim-table-of-contents*
Expand All @@ -11,6 +11,7 @@ Table of Contents *nordic.nvim-table-of-contents*
6. ⚙️ Configuration |nordic.nvim-⚙️-configuration|
7. 🗒️ Supported Plugins and Platforms|nordic.nvim-🗒️-supported-plugins-and-platforms|
8. 🎙️ Acknowledgements |nordic.nvim-🎙️-acknowledgements|
9. Links |nordic.nvim-links|

==============================================================================
1. 🌒 Nordic *nordic.nvim-🌒-nordic*
Expand All @@ -26,12 +27,6 @@ If there is anything that does not seem right, even if it is a very small
highlight, please let me know with an issue or PR!


💡 LOOKING FOR MAINTAINERS

Currently looking for maintainers. If you are keen, head on over to the
discussion <https://github.com/AlexvZyl/nordic.nvim/discussions/96>.


==============================================================================
2. 📷 Showcase *nordic.nvim-📷-showcase*

Expand Down Expand Up @@ -140,7 +135,7 @@ default configuration.
bold = false,
-- Bold cursorline number.
bold_number = true,
-- Avialable styles: 'dark', 'light'.
-- Available styles: 'dark', 'light'.
theme = 'dark',
-- Blending the cursorline bg with the buffer bg.
blend = 0.85,
Expand Down Expand Up @@ -186,8 +181,8 @@ An example of overriding the `TelescopePromptTitle` colors:
==============================================================================
7. 🗒️ Supported Plugins and Platforms*nordic.nvim-🗒️-supported-plugins-and-platforms*

For the list of supported plugins, please take a look at this directory
<https://github.com/AlexvZyl/nordic.nvim/tree/main/lua/nordic/groups/integrations>.
For the list of supported plugins, please take a look at this file
<https://github.com/AlexvZyl/nordic.nvim/blob/main/lua/nordic/groups/integrations.lua>.
For the list of supported platforms, please take a look at this directory
<https://github.com/AlexvZyl/nordic.nvim/tree/main/platforms>.

Expand Down
6 changes: 2 additions & 4 deletions lua/nordic/colors/init.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,7 @@ function C.extend_palette()
-- Some of the format is from @folke/tokyonight.nvim.

-- Backgrounds
C.bg = (options.transparent_bg and C.none) or
((options.swap_backgrounds and C.black1) or C.gray0)
C.bg = (options.transparent_bg and C.none) or ((options.swap_backgrounds and C.black1) or C.gray0)
C.bg_dark = (options.transparent_bg and C.none) or C.black0
C.bg_sidebar = (options.transparent_bg and C.none) or C.bg
C.bg_popup = (options.transparent_bg and C.none) or C.bg
Expand Down Expand Up @@ -61,8 +60,7 @@ function C.extend_palette()
C.fg_popup_border = C.border_fg

-- Floating windows
C.bg_float = (options.transparent_bg and C.none) or
((options.swap_backgrounds and C.gray0) or C.black1)
C.bg_float = (options.transparent_bg and C.none) or ((options.swap_backgrounds and C.gray0) or C.black1)
C.fg_float = C.fg
C.bg_float_border = C.bg_float
C.fg_float_border = C.border_fg
Expand Down
12 changes: 3 additions & 9 deletions lua/nordic/groups/init.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,10 @@ local merge = require('nordic.utils').merge
local M = {}

function M.get_groups()
local groups = merge(
require('nordic.groups.native').get_groups(),
require('nordic.groups.integrations').get_groups()
)
local groups =
merge(require('nordic.groups.native').get_groups(), require('nordic.groups.integrations').get_groups())


return merge(
groups,
require 'nordic.config'.options.override
)
return merge(groups, require('nordic.config').options.override)
end

function M.set_term_colors()
Expand Down
135 changes: 67 additions & 68 deletions lua/nordic/groups/integrations.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ local M = {}

function M.get_groups()
local C = require 'nordic.colors'
local O = require 'nordic.config'.options
local O = require('nordic.config').options

local G = {}

Expand Down Expand Up @@ -86,16 +86,16 @@ function M.get_groups()

-- Mini Statusline.
local LC = require 'lualine.themes.nordic'
G.MiniStatuslineModeNormal = { bg = LC.normal.a.bg, fg = LC.normal.a.fg, bold = LC.normal.a.gui == 'bold', }
G.MiniStatuslineModeInsert = { bg = LC.insert.a.bg, fg = LC.insert.a.fg, bold = LC.insert.a.gui == 'bold', }
G.MiniStatuslineModeVisual = { bg = LC.visual.a.bg, fg = LC.visual.a.fg, bold = LC.visual.a.gui == 'bold', }
G.MiniStatuslineModeReplace = { bg = LC.replace.a.bg, fg = LC.replace.a.fg, bold = LC.replace.a.gui == 'bold', }
G.MiniStatuslineModeCommand = { bg = LC.command.a.bg, fg = LC.command.a.fg, bold = LC.command.a.gui == 'bold', }
G.MiniStatuslineModeOther = { bg = LC.terminal.a.bg, fg = LC.terminal.a.fg, bold = LC.terminal.a.gui == 'bold', }
G.MiniStatuslineDevinfo = { bg = LC.normal.b.bg, fg = LC.normal.b.fg, }
G.MiniStatuslineFilename = { bg = LC.normal.c.bg, fg = LC.normal.c.fg, }
G.MiniStatuslineFileinfo = { bg = LC.normal.b.bg, fg = LC.normal.b.fg, }
G.MiniStatuslineInactive = { bg = LC.inactive.a.bg, fg = LC.inactive.a.fg, bold = LC.inactive.a.gui == 'bold', }
G.MiniStatuslineModeNormal = { bg = LC.normal.a.bg, fg = LC.normal.a.fg, bold = LC.normal.a.gui == 'bold' }
G.MiniStatuslineModeInsert = { bg = LC.insert.a.bg, fg = LC.insert.a.fg, bold = LC.insert.a.gui == 'bold' }
G.MiniStatuslineModeVisual = { bg = LC.visual.a.bg, fg = LC.visual.a.fg, bold = LC.visual.a.gui == 'bold' }
G.MiniStatuslineModeReplace = { bg = LC.replace.a.bg, fg = LC.replace.a.fg, bold = LC.replace.a.gui == 'bold' }
G.MiniStatuslineModeCommand = { bg = LC.command.a.bg, fg = LC.command.a.fg, bold = LC.command.a.gui == 'bold' }
G.MiniStatuslineModeOther = { bg = LC.terminal.a.bg, fg = LC.terminal.a.fg, bold = LC.terminal.a.gui == 'bold' }
G.MiniStatuslineDevinfo = { bg = LC.normal.b.bg, fg = LC.normal.b.fg }
G.MiniStatuslineFilename = { bg = LC.normal.c.bg, fg = LC.normal.c.fg }
G.MiniStatuslineFileinfo = { bg = LC.normal.b.bg, fg = LC.normal.b.fg }
G.MiniStatuslineInactive = { bg = LC.inactive.a.bg, fg = LC.inactive.a.fg, bold = LC.inactive.a.gui == 'bold' }

-- Nvim tree.
G.NvimTreeNormal = { fg = C.fg, bg = C.bg }
Expand Down Expand Up @@ -280,20 +280,20 @@ function M.get_groups()
G['@comment'] = { link = 'Comment' }
--G['@comment.documentation'] = { link = 'Comment' }
G['@comment.documentation'] = { link = 'Comment' }
G["@comment.note"] = { fg = C.hint }
G["@comment.error"] = { fg = C.error }
G["@comment.hint"] = { fg = C.hint }
G["@comment.info"] = { fg = C.info }
G["@comment.warning"] = { fg = C.warning }
G["@comment.todo"] = { fg = C.todo }
G['@comment.note'] = { fg = C.hint }
G['@comment.error'] = { fg = C.error }
G['@comment.hint'] = { fg = C.hint }
G['@comment.info'] = { fg = C.info }
G['@comment.warning'] = { fg = C.warning }
G['@comment.todo'] = { fg = C.todo }
G['@operator'] = { fg = C.fg } -- For any operator: `+`, but also `->` and `*` in C.
--- Punctuation
G['@punctuation.delimiter'] = { link = 'Delimiter' } -- For delimiters ie: `.`
G['@punctuation.bracket'] = { link = '@operator' } -- For brackets and parens.
G['@punctuation.special'] = { link = 'Macro' } -- For special punctutation that does not fall in the catagories before.
G['@punctuation.special.markdown'] = { fg = C.orange.base, bold = true }
--- Literals
G["@string"] = { link = "String" }
G['@string'] = { link = 'String' }
G['@string.documentation'] = { link = 'String' }
G['@string.escape'] = { fg = C.magenta.bright } -- For escape characters within a string.
G['@string.regex'] = { fg = C.magenta.bright } -- For regexes.
Expand All @@ -303,19 +303,19 @@ function M.get_groups()
G['@parameter.builtin'] = { link = 'Builtin' } -- For builtin parameters of a function, e.g. "..." or Smali's pG[1-99]
--- Keywords
G['@keyword'] = { link = 'Keyword' } -- For keywords that don't fall in previous categories.
G["@keyword.conditional"] = { link = "Conditional" }
G['@keyword.conditional'] = { link = 'Conditional' }
G['@keyword.coroutine'] = { link = 'Macro' } -- For keywords related to coroutines.
G["@keyword.debug"] = { link = "Debug" }
G["@keyword.directive"] = { link = "PreProc" }
G["@keyword.directive.define"] = { link = "Define" }
G["@keyword.exception"] = { link = "Exception" }
G['@keyword.debug'] = { link = 'Debug' }
G['@keyword.directive'] = { link = 'PreProc' }
G['@keyword.directive.define'] = { link = 'Define' }
G['@keyword.exception'] = { link = 'Exception' }
G['@keyword.export'] = { link = 'Keyword' }
G['@keyword.function'] = { link = 'Keyword' } -- For keywords used to define a fuction.
G["@keyword.import"] = { link = "Include" }
G['@keyword.import'] = { link = 'Include' }
G['@keyword.operator'] = { link = 'Keyword' }
G["@keyword.repeat"] = { link = "Repeat" }
G['@keyword.repeat'] = { link = 'Repeat' }
G['@keyword.return'] = { link = 'Keyword' }
G["@keyword.storage"] = { link = "StorageClass" }
G['@keyword.storage'] = { link = 'StorageClass' }
G['@label'] = { link = 'Keyword' } -- For labels: `label:` in C and `:label:` in Lua.
--- Types
G['@type.builtin'] = { link = 'Type' }
Expand Down Expand Up @@ -347,32 +347,32 @@ function M.get_groups()
G['@text.todo'] = { link = 'Todo' }
G['@text.note'] = { link = 'Note' }
--- Markup
G["@markup"] = { link = "@none" }
G["@markup.emphasis"] = { italic = true }
G["@markup.environment"] = { link = "Macro" }
G["@markup.environment.name"] = { link = "Type" }
G["@markup.heading"] = { link = "Title" }
G["@markup.heading.1"] = { fg = C.yellow.base, bold = true }
G["@markup.heading.2"] = { fg = C.orange.base, bold = true }
G["@markup.heading.3"] = { fg = C.magenta.base, bold = true }
G["@markup.heading.4"] = { fg = C.green.base }
G["@markup.heading.5"] = { fg = C.blue2, italic = true }
G["@markup.heading.6"] = { fg = C.cyan.base, italic = true }
G["@markup.italic"] = { italic = true }
G['@markup'] = { link = '@none' }
G['@markup.emphasis'] = { italic = true }
G['@markup.environment'] = { link = 'Macro' }
G['@markup.environment.name'] = { link = 'Type' }
G['@markup.heading'] = { link = 'Title' }
G['@markup.heading.1'] = { fg = C.yellow.base, bold = true }
G['@markup.heading.2'] = { fg = C.orange.base, bold = true }
G['@markup.heading.3'] = { fg = C.magenta.base, bold = true }
G['@markup.heading.4'] = { fg = C.green.base }
G['@markup.heading.5'] = { fg = C.blue2, italic = true }
G['@markup.heading.6'] = { fg = C.cyan.base, italic = true }
G['@markup.italic'] = { italic = true }
G['@markup.list'] = { link = '@operator' }
G["@markup.list.checked"] = { link = 'Field' }
G['@markup.list.checked'] = { link = 'Field' }
G['@markup.list.markdown'] = { fg = C.yellow.base, bold = true }
G["@markup.list.unchecked"] = { fg = C.fg }
G['@markup.list.unchecked'] = { fg = C.fg }
G['@markup.link'] = { fg = C.cyan.base }
G["@markup.link.label"] = { link = "SpecialChar" }
G["@markup.link.label.symbol"] = { link = "Identifier" }
G["@markup.link.url"] = { link = "Underlined" }
G["@markup.math"] = { link = "Special" }
G["@markup.raw"] = { link = "String" }
G['@markup.link.label'] = { link = 'SpecialChar' }
G['@markup.link.label.symbol'] = { link = 'Identifier' }
G['@markup.link.url'] = { link = 'Underlined' }
G['@markup.math'] = { link = 'Special' }
G['@markup.raw'] = { link = 'String' }
G['@markup.raw.markdown_inline'] = { bg = C.black2, fg = C.fg }
G["@markup.strong"] = { bold = true }
G["@markup.strikethrough"] = { strikethrough = true }
G["@markup.underline"] = { underline = true }
G['@markup.strong'] = { bold = true }
G['@markup.strikethrough'] = { strikethrough = true }
G['@markup.underline'] = { underline = true }
-- TSX
G['@tag.tsx'] = { fg = C.blue1 }
G['@constructor.tsx'] = { fg = C.blue1 }
Expand Down Expand Up @@ -411,12 +411,12 @@ function M.get_groups()
G['@lsp.typemod.variable.injected'] = { link = 'Variable' }
G['@lsp.typemod.variable.globalScope'] = { link = 'Macro' }
-- Things that seems to be missing?
G["@annotation"] = { link = "PreProc" }
G["@diff.plus"] = { link = "DiffAdd" }
G["@diff.minus"] = { link = "DiffDelete" }
G["@diff.delta"] = { link = "DiffChange" }
G["@character"] = { link = "Character" }
G["@character.special"] = { link = "SpecialChar" }
G['@annotation'] = { link = 'PreProc' }
G['@diff.plus'] = { link = 'DiffAdd' }
G['@diff.minus'] = { link = 'DiffDelete' }
G['@diff.delta'] = { link = 'DiffChange' }
G['@character'] = { link = 'Character' }
G['@character.special'] = { link = 'SpecialChar' }
G['@string.special'] = { fg = C.yellow.base } -- For escape characters within a string.
G['@tag'] = { fg = C.blue1 } -- Tags like html tag names.
G['@tag.delimiter'] = { fg = C.fg } -- Tag delimiter like `<` `>` `/`
Expand All @@ -432,7 +432,7 @@ function M.get_groups()
G['@class'] = { link = 'Keyword' }
G['@include'] = { link = 'Include' }
G['@macro'] = { link = 'Macro' }
G["@module"] = { fg = C.yellow.base }
G['@module'] = { fg = C.yellow.base }
G['@module.builtin'] = { link = 'Builtin' }
G['@preproc'] = { link = 'Macro' }
G['@attribute'] = { link = 'Macro' }
Expand Down Expand Up @@ -466,19 +466,18 @@ function M.get_groups()
G.TreesitterContextLineNumber = { fg = fg, bg = bg }

-- Neorg
G["@neorg.headings.1.title"] = { link = "@markup.heading.1" }
G["@neorg.headings.1.prefix"] = { link = "@markup.heading.1" }
G["@neorg.headings.2.title"] = { link = "@markup.heading.2" }
G["@neorg.headings.2.prefix"] = { link = "@markup.heading.2" }
G["@neorg.headings.3.title"] = { link = "@markup.heading.3" }
G["@neorg.headings.3.prefix"] = { link = "@markup.heading.3" }
G["@neorg.headings.4.title"] = { link = "@markup.heading.4" }
G["@neorg.headings.4.prefix"] = { link = "@markup.heading.4" }
G["@neorg.headings.5.title"] = { link = "@markup.heading.5" }
G["@neorg.headings.5.prefix"] = { link = "@markup.heading.5" }
G["@neorg.headings.6.title"] = { link = "@markup.heading.6" }
G["@neorg.headings.6.prefix"] = { link = "@markup.heading.6" }

G['@neorg.headings.1.title'] = { link = '@markup.heading.1' }
G['@neorg.headings.1.prefix'] = { link = '@markup.heading.1' }
G['@neorg.headings.2.title'] = { link = '@markup.heading.2' }
G['@neorg.headings.2.prefix'] = { link = '@markup.heading.2' }
G['@neorg.headings.3.title'] = { link = '@markup.heading.3' }
G['@neorg.headings.3.prefix'] = { link = '@markup.heading.3' }
G['@neorg.headings.4.title'] = { link = '@markup.heading.4' }
G['@neorg.headings.4.prefix'] = { link = '@markup.heading.4' }
G['@neorg.headings.5.title'] = { link = '@markup.heading.5' }
G['@neorg.headings.5.prefix'] = { link = '@markup.heading.5' }
G['@neorg.headings.6.title'] = { link = '@markup.heading.6' }
G['@neorg.headings.6.prefix'] = { link = '@markup.heading.6' }

-- Trouble.
G.TroubleNormal = { bg = C.bg_float }
Expand Down
20 changes: 5 additions & 15 deletions lua/nordic/groups/native.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,15 @@ local M = {}

function M.get_groups()
local C = require 'nordic.colors'
local O = require 'nordic.config'.options
local O = require('nordic.config').options

local G = {}


-- SYNTAX


G.Constant = { fg = C.magenta.bright } -- (preferred) any constant
G.Number = { link = 'Constant' } -- a number constant: 234 0xff
G.Boolean = { link = 'Number' } -- a boolean constant: TRUE false
G.Constant = { fg = C.magenta.bright } -- (preferred) any constant
G.Number = { link = 'Constant' } -- a number constant: 234 0xff
G.Boolean = { link = 'Number' } -- a boolean constant: TRUE false
G.Float = { link = 'Number' } -- a floating point constant: 2.3e10
G.None = { fg = C.none, bg = C.none }
G.String = { fg = C.green.base } -- a string constant: "this is a string"
Expand Down Expand Up @@ -49,7 +47,7 @@ function M.get_groups()
G.Special = { fg = C.blue1 } -- (preferred) any special symbol
-- SpecialChar = { } -- special character in a constant
-- Tag = { } -- you can use CTRL-] on this
G.Delimiter = { italic = true, fg = C.gray5} -- character that needs attention
G.Delimiter = { italic = true, fg = C.gray5 } -- character that needs attention
-- SpecialComment= { } -- special things inside a comment
-- Debug = { } -- debugging statements
G.Underlined = { underline = true } -- (preferred) text that stands out, HTML links
Expand Down Expand Up @@ -88,10 +86,8 @@ function M.get_groups()
G.debugPC = { bg = C.bg_sidebar } -- used for highlighting the current line in terminal-debug
G.debugBreakpoint = { fg = C.red.bright } -- used for breakpoint colors in terminal-debug


-- LANGUAGE SERVER PROTOCOL


-- These groups are for the native LSP client. Some other LSP clients may
-- use these groups, or use their own. Consult your LSP client's
-- documentation.
Expand All @@ -118,10 +114,8 @@ function M.get_groups()
G.ALEErrorSign = { fg = C.error }
G.ALEWarningSign = { fg = C.warning }


-- EDITOR


G.Comment = { fg = C.comment, italic = O.italic_comments } -- any comment
G.ColorColumn = { bg = C.bg_visual } -- used for the columns set with 'colorcolumn'
G.Conceal = { fg = C.gray3 } -- placeholder characters substituted for concealed text (see 'conceallevel')
Expand Down Expand Up @@ -185,10 +179,8 @@ function M.get_groups()
G.WinBar = { bg = C.bg_dark, fg = C.gray5 }
G.WinBarNC = { bg = C.bg_dark, fg = C.gray4 }


-- DIFF


G.DiffAdd = { bg = C.diff.add, bold = true } -- diff mode: Added line |diff.txt|
G.DiffChange = { bg = C.diff.change0 } -- diff mode: Changed line |diff.txt|
G.DiffDelete = { bg = C.diff.delete, bold = true } -- diff mode: Deleted line |diff.txt|
Expand All @@ -202,9 +194,7 @@ function M.get_groups()
G.diffLine = {}
G.diffIndexLine = {}


return G

end

return M
4 changes: 1 addition & 3 deletions lua/nordic/init.lua
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,7 @@ function M.load(opts)
vim.g.colors_name = U.NAME
end

if opts then
require 'nordic.config'.setup(opts)
end
if opts then require('nordic.config').setup(opts) end

-- Setup colors
require('nordic.colors').extend_palette()
Expand Down

0 comments on commit 03fcff3

Please sign in to comment.