nvim/maxmx03.solarized.nvim
1
0
Fork 0
mirror of https://github.com/maxmx03/solarized.nvim.git synced 2026-09-10 07:26:26 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity

chore(doc): auto generate docs

Browse source
This commit is contained in:
github-actions[bot] 2024-03-28 14:25:16 +00:00 committed by Max Miliano
parent a630aa5593
commit 3070d9e982
1 changed files with 3 additions and 64 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

67
doc/solarized.nvim.txt
View file

@ -1,4 +1,4 @@
*solarized.nvim.txt* For NVIM v0.9.1 Last change: 2023 December 24
*solarized.nvim.txt* For NVIM v0.9.4 Last change: 2024 March 28
==============================================================================
Table of Contents *solarized.nvim-table-of-contents*
@ -22,6 +22,7 @@ Table of Contents *solarized.nvim-table-of-contents*
- Contributing |solarized.nvim-contributing|
- Designed by |solarized.nvim-designed-by|
- Credits and Reference 🎉 |solarized.nvim-credits-and-reference-🎉|
1. Links |solarized.nvim-links|
Solarized is a sixteen color palette (eight monotones, eight accent colors)
designed for use with terminal and gui applications. click here to learn more
@ -396,69 +397,7 @@ HOW TO GET COLOR TINTS ~
CONTRIBUTING *solarized.nvim-contributing*
Thank you for your interest in contributing to this project! To ensure a smooth
collaboration, please follow the guidelines below:
1. **Branching**: Make your changes on the `dev` branch. Avoid making direct
changes to the `main` branch.
2. **Testing**: Before submitting a pull request, run the `./test.py` script to
ensure that your changes pass all necessary tests. This step helps maintain the
quality and stability of the project. Ensure that the following dependencies
are installed for running tests:
>bash
sudo apt install luarocks
sudo luarocks install luacheck
sudo luarocks install vusted
cargo install stylua
<
>bash
./test.py
<
>bash
ok 1 - Color Conversions Convert hex to RGB
ok 2 - Color Conversions Convert RGB to hex
ok 3 - Color Conversions Darken the color by percentage
ok 4 - Color Conversions Lighten the color by percentage
ok 5 - Color Conversions Blend colors
ok 6 - Configuration Default configuration
ok 7 - Configuration Unique configuration table instances
ok 8 - Configuration Extend default configuration
ok 9 - Initialization Loads without encountering any errors
ok 10 - Initialization Background is set to light
ok 11 - Palette Extend solarized color palette
ok 12 - Palette Correct any invalid colors when extending the solarized palette
ok 13 - Setup Customizing Highlight Groups
ok 14 - Setup Changing Comment Style
ok 15 - Setup Changing Function Style
ok 16 - Setup Customizable Highlight Groups Without Losing Previous Configuration
ok 17 - Setup Ability to Change the Default Theme
1..17
# Success: 17
<
3. **Pull Request**: When submitting a pull request, select the `dev` branch as
the target branch. This ensures that your changes will be merged into the `dev`
branch for further review and integration.
4. **Provide Details**: Provide a clear and descriptive title and description for
your pull request, explaining the purpose and scope of your changes.
5. **Review Process**: Wait for the maintainer to review your pull request. The
maintainers will review your changes before merging.
6. **Final Approval**: Once your changes have been reviewed and approved, the
project maintainer will handle merging your changes into the `main` branch.
Pull requests are welcome and appreciated.
DESIGNED BY *solarized.nvim-designed-by*