Skip to content

Commit f9759dc

Browse files
auto-generate vimdoc
1 parent e6b0bb0 commit f9759dc

File tree

1 file changed

+53
-7
lines changed

1 file changed

+53
-7
lines changed

doc/astral-docs.txt

Lines changed: 53 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*astral-docs.txt* For Neovim >= 0.9.0 Last change: 2024 July 26
1+
*astral-docs.txt* For Neovim >= 0.9.0 Last change: 2024 July 27
22

33
==============================================================================
44
Table of Contents *astral-docs-table-of-contents*
@@ -9,21 +9,26 @@ Table of Contents *astral-docs-table-of-contents*
99
- Configuration |astral-docs-astral.nvim-configuration|
1010
- Commands |astral-docs-astral.nvim-commands|
1111
- Autocommands |astral-docs-astral.nvim-autocommands|
12+
- Troubleshooting |astral-docs-astral.nvim-troubleshooting|
1213
- License |astral-docs-astral.nvim-license|
1314
- Contributing |astral-docs-astral.nvim-contributing|
1415
2. Links |astral-docs-links|
1516

1617
==============================================================================
1718
1. astral.nvim *astral-docs-astral.nvim*
1819

19-
20+
<https://dotfyle.com/plugins/rootiest/astral.nvim>
2021

2122
`astral.nvim` is a Neovim plugin for colorscheme management.
2223

24+
This very simple plugin allows Neovim to remember the last used colorscheme and
25+
restore it when Neovim opens.
26+
2327

2428
FEATURES *astral-docs-astral.nvim-features*
2529

2630
- Remembers the last used colorscheme and restores it when Neovim opens.
31+
- Allows setting fallback themes if the saved colorscheme is not available.
2732

2833

2934
INSTALLATION *astral-docs-astral.nvim-installation*
@@ -34,7 +39,7 @@ Using `lazy.nvim`, add the plugin to your configuration:
3439
require("lazy").setup({
3540
{
3641
"astral/astral.nvim",
37-
version = "*",
42+
version = "*", -- Pin to GitHub releases
3843
},
3944
})
4045
<
@@ -53,22 +58,31 @@ The default values for `astral` configuration are:
5358
>lua
5459
local config = {
5560
restore_colors = true, -- Enable or disable automatic colorscheme restoration
61+
fallback_themes = { -- Default fallback themes
62+
"catppuccin",
63+
"tokyonight",
64+
"default"
65+
},
5666
}
5767
<
5868

5969

6070
EXAMPLE CONFIGURATION ~
6171

62-
To manually set all default values (though they are already set by default),
63-
use the following `lazy.nvim` configuration:
72+
To set the options for `astral`, use the following `lazy.nvim` configuration:
6473

6574
>lua
6675
require("lazy").setup({
6776
{
6877
"astral/astral.nvim",
69-
version = "*",
78+
version = "*", -- Pin to GitHub releases
7079
opts = {
7180
restore_colors = true, -- Set to false to disable colorscheme restoration
81+
fallback_themes = { -- Customize fallback themes
82+
"catppuccin",
83+
"tokyonight",
84+
"default"
85+
},
7286
}
7387
},
7488
})
@@ -85,6 +99,37 @@ AUTOCOMMANDS *astral-docs-astral.nvim-autocommands*
8599
- **ColorScheme**Store the new name when the colorscheme changes.
86100

87101

102+
TROUBLESHOOTING *astral-docs-astral.nvim-troubleshooting*
103+
104+
If you encounter issues with `astral.nvim`, here are some common problems and
105+
solutions:
106+
107+
1. **Colorscheme not restoring on startup**- Ensure`restore_colors` is set to `true` in the configuration.
108+
- Check if the `settings.json` file exists in the `data` path
109+
(`vim.fn.stdpath("data") .. "/lazy/astral.nvim/settings.json"`).
110+
If not, the plugin should create it automatically.
111+
112+
113+
2. **Fallback themes not applied**- Verifythat the `fallback_themes` array in the configuration contains
114+
valid colorscheme names.
115+
- Ensure that the fallback themes are installed and available in Neovim.
116+
117+
118+
3. **Unknown Astral command error**- Ensureyou are using valid commands. The available command is `:Astral reset`.
119+
120+
121+
4. **Colorscheme changes not saved**- Ensurethere are no errors in the autocommand that triggers
122+
on the `ColorScheme` event.
123+
- Check if the `settings.json` file is writable and that your
124+
Neovim configuration allows writing to this path.
125+
126+
127+
128+
If the issue persists, please open an issue on the GitHub repository
129+
<https://github.com/rootiest/astral.nvim> with details about your configuration
130+
and the problem you are facing.
131+
132+
88133
LICENSE *astral-docs-astral.nvim-license*
89134

90135
`astral.nvim` is licensed under the MIT License. See LICENSE <LICENSE> for
@@ -101,7 +146,8 @@ GitHub repository <https://github.com/astral/astral.nvim>.
101146

102147
1. *GitHub Workflow Status*: https://img.shields.io/github/actions/workflow/status/rootiest/astral.nvim/lint-test.yml?branch=main&style=for-the-badge
103148
2. *Lua*: https://img.shields.io/badge/Made%20with%20Lua-blueviolet.svg?style=for-the-badge&logo=lua
104-
3. *Astral*: astral.png
149+
3. *Astral.nvim*: https://dotfyle.com/plugins/rootiest/astral.nvim/shield?style=for-the-badge
150+
4. *Astral*: astral.png
105151

106152
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
107153

0 commit comments

Comments
 (0)