docs(readme): document plug-n-play theme system#34
Merged
Conversation
Replace the outdated "UI Theme" section (which still named Tokyonight as the default) with a dedicated "Themes" section covering the plug-n-play system: one file per colorscheme under lua/themes/, auto-discovery in theme.lua, the :Theme switch command with persistence, how to add a theme, and the bundled low-eyestrain themes. Correct the default to gruvbox (Gruvbox Material). Add lua/themes/ to the directory structure and update the theme.lua and settings.lua descriptions accordingly.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Updates the README for relevance and adds a dedicated section for the theme system introduced in #33.
Relevance fixes
lua/themes/, and thetheme.lua/settings.luadescriptions reflect the auto-discovery loader.New "Themes" section
Documents the plug-n-play system as a standalone section:
lua/themes/<name>.lua(a lazy.nvim spec), auto-discovered bylua/theme.lua;:Theme(with persistence to a machine-local state file) and changing the default insettings.lua;lualinetheme = "auto"behaviour.Docs-only; no config or behaviour changes.