Skip to content

black-atom-industries/nvim

Repository files navigation

Black Atom for Neovim

A collection of elegant, cohesive themes for Neovim by Black Atom Industries

What is a Black Atom Adapter?

This repository is a Neovim adapter for the Black Atom theme ecosystem. In the Black Atom architecture:

  • The core repository is the single source of truth for all theme definitions
  • Each adapter implements these themes for a specific platform (Neovim, VS Code, Alacritty, etc.)
  • The adapter uses templates to transform core theme definitions into platform-specific files

This modular approach ensures consistent colors and styling across all supported platforms while allowing for platform-specific optimizations.

Available Themes

Black Atom includes multiple theme collections, each with dark and light variants:

Collection Description
Default Core Black Atom themes
JPN Japanese-inspired themes
MNML Minimalist accent themes
Stations Space station-inspired themes
Terra Earth season-inspired themes

Installation

Install the plugin with your preferred package manager:

{
  "black-atom-industries/nvim",
  name = "black-atom",
  priority = 1000, -- Load before other start plugins
  opts = {
    -- Configuration options
    theme = "black-atom-jpn-koyo-yoru", -- Default theme
    transparent = false, -- Enable transparent background
    contrast = false, -- Enable high contrast mode
  },
}
Plug 'black-atom-industries/nvim'

" In your init.vim or .vimrc
lua << EOF
require('black-atom').setup({
  theme = "black-atom-jpn-koyo-yoru",
  transparent = false,
  contrast = false,
})
EOF

Usage

Basic Configuration

require('black-atom').setup({
  -- Default theme (will be used when Neovim starts)
  theme = "black-atom-jpn-koyo-yoru",

  -- Enable transparent background
  transparent = false,

  -- Enable high contrast mode
  contrast = false,

  -- Override specific highlight groups
  overrides = {
    -- Add your highlight overrides here
    -- Example: Normal = { bg = "#000000" }
  },
})

Supported Plugins

Click to expand supported plugins list

This theme supports the following plugins:

Contributing

Contributions are welcome! If you'd like to add support for additional plugins or improve existing themes:

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Create a pull request

See CONTRIBUTION.md for detailed guidelines.

Development

Roadmap

  • Minimize default highlight assignments
    • The default assignment and links should be used as far as possible
  • Make API stable
  • Dediated Black Atom Colorscheme Picker

Setup

Clone the repository:

git clone https://github.com/black-atom-industries/nvim.git
cd nvim

Building and Testing

sh check.sh

Working with Templates

Theme files are generated from templates using Black Atom Core. You need Deno installed.

  1. Edit the template files in lua/black-atom/themes/{collection}/
  2. Generate theme files:
    deno task generate
  3. Or use watch mode for live regeneration:
    deno task dev

License

MIT - See LICENSE for details

Related Projects

About

Black Atom Adapter for the Neovim editor

Topics

Resources

License

Stars

Watchers

Forks

Contributors