auto generate docs
This commit is contained in:
mcchrish
123
doc/zenbones.txt
123
doc/zenbones.txt
@@ -7,11 +7,6 @@ Table of Contents *zenbones-table-of-contents*
|
||||
- Requirements |zenbones-requirements|
|
||||
- Installation |zenbones-installation|
|
||||
- Usage |zenbones-usage|
|
||||
- Showcase |zenbones-showcase|
|
||||
- Other plugins support |zenbones-other-plugins-support|
|
||||
- Advance Usage |zenbones-advance-usage|
|
||||
- Other implementations |zenbones-other-implementations|
|
||||
- Inspirations |zenbones-inspirations|
|
||||
|
||||
==============================================================================
|
||||
1. Zenbones *zenbones-zenbones*
|
||||
@@ -77,18 +72,19 @@ Alternatively, if you want to make use of the lua version:
|
||||
It works pretty much the same as the first one but pretty handy when extending
|
||||
or customizing the colors to your likings.
|
||||
|
||||
SHOWCASE *zenbones-showcase*
|
||||
|
||||
|
||||
|
||||
|
||||
<details>
|
||||
|
||||
<summary>
|
||||
|
||||
Diff highlights
|
||||
|
||||
|
||||
</summary>
|
||||
|
||||
<img width="1128" alt="Vim diff"
|
||||
src="https://user-images.githubusercontent.com/7200153/130730698-38c2f493-4161-4146-bb68-00cd9a87d2bd.png">
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
@@ -96,12 +92,11 @@ src="https://user-images.githubusercontent.com/7200153/130730698-38c2f493-4161-4
|
||||
|
||||
<summary>
|
||||
|
||||
Search
|
||||
|
||||
|
||||
</summary>
|
||||
|
||||
<img width="1128" alt="Search"
|
||||
src="https://user-images.githubusercontent.com/7200153/130731292-928fcffc-c252-425c-8c61-e292df3fa478.png">
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
@@ -109,106 +104,60 @@ src="https://user-images.githubusercontent.com/7200153/130731292-928fcffc-c252-4
|
||||
|
||||
<summary>
|
||||
|
||||
Diagnostics
|
||||
|
||||
|
||||
</summary>
|
||||
|
||||
<img width="1128" alt="Diagnostics"
|
||||
src="https://user-images.githubusercontent.com/7200153/130927693-00cd8a6e-7a75-4ebb-9f23-b9322de7933a.png">
|
||||
|
||||
|
||||
</details>
|
||||
|
||||
_Font used is |zenbones-Iosevka-Curly-Slab|_.
|
||||
|
||||
OTHER PLUGINS SUPPORT *zenbones-other-plugins-support*
|
||||
|
||||
Aside from LSP and basic Tree-sitter support, there are only a few plugins that
|
||||
are currently supported. Please feel free to open a PR to support your favorite
|
||||
plugins.
|
||||
|
||||
|
||||
- |zenbones-gitsigns|
|
||||
- |zenbones-indent-blankline|
|
||||
- |zenbones-Telescope|
|
||||
- |zenbones-sneak|
|
||||
- |zenbones-lualine| (requires Lush)
|
||||
- |zenbones-barbar.nvim|
|
||||
|
||||
|
||||
ADVANCE USAGE *zenbones-advance-usage*
|
||||
|
||||
Zenbones is pretty extensible thanks to |zenbones-Lush|. You can easily
|
||||
retrieve the colors in lua:
|
||||
|
||||
>
|
||||
local theme = require "zenbones"
|
||||
local colors = require "zenbones.colors"
|
||||
|
||||
print(theme.StatusLine.bg.hex)
|
||||
print(sand.darken(20).hex)
|
||||
<
|
||||
|
||||
|
||||
One such example is the custom |zenbones-lualine| theme.
|
||||
|
||||
See also |zenbones-Lush’s-documentation| for the complete options.
|
||||
|
||||
OTHER IMPLEMENTATIONS *zenbones-other-implementations*
|
||||
|
||||
|
||||
- |zenbones-iterm2|
|
||||
|
||||
|
||||
*zenbones-Print terminal colors*
|
||||
|
||||
Print terminal colors You can retrieve the terminal colors by
|
||||
using this command:
|
||||
|
||||
|
||||
>
|
||||
:lua require("zenbones.print").print_terminal_colors()
|
||||
|
||||
...
|
||||
Terminal colors
|
||||
foreground: #2C363C
|
||||
background: #F0EDEC
|
||||
ansi color0: #2C363C
|
||||
ansi color1: #C23C55
|
||||
ansi color2: #617437
|
||||
ansi color3: #914B27
|
||||
ansi color4: #286486
|
||||
ansi color5: #88507D
|
||||
...
|
||||
<
|
||||
|
||||
|
||||
Useful when you want to apply a zenbones theme to your terminal.
|
||||
|
||||
INSPIRATIONS *zenbones-inspirations*
|
||||
|
||||
Zenbones is heavily inspired by |zenbones-Verdandi| and
|
||||
|zenbones-vim-yin-yang|. The name came from a book called
|
||||
|zenbones-Zen-Flesh,-Zen-Bones|.
|
||||
|
||||
There are more similar
|
||||
|zenbones-colorschemes-with-few-colors-from-this-collection|.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
==============================================================================
|
||||
2. Links *zenbones-links*
|
||||
|
||||
1. *zenbones-Iosevka-Curly-Slab*: https://typeof.net/Iosevka/
|
||||
2. *zenbones-gitsigns*: https://github.com/lewis6991/gitsigns.nvim
|
||||
3. *zenbones-indent-blankline*: https://github.com/lukas-reineke/indent-blankline.nvim
|
||||
4. *zenbones-Telescope*: https://github.com/nvim-telescope/telescope.nvim
|
||||
5. *zenbones-sneak*: https://github.com/justinmk/vim-sneak
|
||||
6. *zenbones-lualine*: https://github.com/hoob3rt/lualine.nvim
|
||||
7. *zenbones-barbar.nvim*: https://github.com/romgrk/barbar.nvim
|
||||
8. *zenbones-Lush*: https://github.com/rktjmp/lush.nvim
|
||||
9. *zenbones-lualine*: lua/lualine/themes/zenbones.lua
|
||||
10. *zenbones-Lush’s-documentation*: https://github.com/rktjmp/lush.nvim#advanced-usage
|
||||
11. *zenbones-iterm2*: https://github.com/mcchrish/zenbones-iterm
|
||||
12. *zenbones-Verdandi*: https://github.com/be5invis/vsc-theme-verdandi
|
||||
13. *zenbones-vim-yin-yang*: https://github.com/pgdouyon/vim-yin-yang
|
||||
14. *zenbones-Zen-Flesh,-Zen-Bones*: https://en.wikipedia.org/wiki/Zen_Flesh,_Zen_Bones
|
||||
15. *zenbones-colorschemes-with-few-colors-from-this-collection*: https://github.com/mcchrish/vim-no-color-collections
|
||||
|
||||
vim:tw=78:ts=8:noet:ft=help:norl:
|
||||
|
||||
Reference in New Issue
Block a user