Skip to content

Commit b846665

Browse files
committed
chore(build): auto-generate vimdoc
1 parent a60a797 commit b846665

2 files changed

Lines changed: 82 additions & 2 deletions

File tree

doc/api.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,16 @@ astrotheme API documentation
44

55
## astrotheme
66

7+
AstroTheme
8+
9+
The default colorscheme used by AstroNvim an aesthetically pleasing and
10+
feature-rich neovim config that is extensible and easy to use with a great
11+
set of plugins
12+
13+
This module can be loaded with `local astrotheme = require "astrotheme"`
14+
15+
copyright 2023 license GNU General Public License v3.0 @class astrocore
16+
717
### config
818

919

@@ -32,9 +42,25 @@ function astrotheme.setup(opts: AstroThemeOpts)
3242

3343
## astrotheme.lib.color
3444

45+
AstroTheme Configuration
46+
47+
Default configuration of AstroTheme
48+
49+
This module can be loaded with `local astrotheme_config = require "astrotheme.lib.color"`
50+
51+
copyright 2023 license GNU General Public License v3.0 @class astrocore
52+
3553

3654
## astrotheme.lib.config
3755

56+
AstroTheme Configuration
57+
58+
Default configuration of AstroTheme
59+
60+
This module can be loaded with `local astrotheme_config = require "astrotheme.lib.config"`
61+
62+
copyright 2023 license GNU General Public License v3.0 @class astrocore
63+
3864
### default
3965

4066

@@ -53,6 +79,14 @@ function astrotheme.lib.config.user_config(opts: AstroThemeOpts)
5379

5480
## astrotheme.lib.util
5581

82+
AstroTheme Utilities
83+
84+
Various utilities for use within AstroTheme
85+
86+
This module can be loaded with `local astrotheme_utils = require "astrotheme.lib.util"`
87+
88+
copyright 2023 license GNU General Public License v3.0 @class astrocore
89+
5690
### get_highlights
5791

5892

doc/astrotheme.txt

Lines changed: 48 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*astrotheme.txt* For Neovim >= 0.9.0 Last change: 2025 September 15
1+
*astrotheme.txt* For Neovim >= 0.9.0 Last change: 2026 January 21
22

33
==============================================================================
44
Table of Contents *astrotheme-table-of-contents*
@@ -16,6 +16,7 @@ Table of Contents *astrotheme-table-of-contents*
1616
- astrotheme.lib.color |astrotheme-lua-api-astrotheme.lib.color|
1717
- astrotheme.lib.config |astrotheme-lua-api-astrotheme.lib.config|
1818
- astrotheme.lib.util |astrotheme-lua-api-astrotheme.lib.util|
19+
2. Links |astrotheme-links|
1920
AstroThemeThe default colorscheme used by AstroNvim an aesthetically pleasing and feature-rich neovim config that is extensible and easy to use with a great set of plugins
2021
FEATURES *astrotheme-features*
2122

@@ -72,7 +73,7 @@ OPTIONS *astrotheme-options*
7273

7374
termguicolors = true, -- Bool value, toggles if termguicolors are set by AstroTheme.
7475

75-
terminal_color = true, -- Bool value, toggles if terminal_colors are set by AstroTheme.
76+
terminal_colors = true, -- Bool value, toggles if terminal_colors are set by AstroTheme.
7677

7778
plugin_default = "auto", -- Sets how all plugins will be loaded
7879
-- "auto": Uses lazy / packer enabled plugins to load highlights.
@@ -353,6 +354,16 @@ astrotheme API documentation
353354

354355
ASTROTHEME *astrotheme-lua-api-astrotheme*
355356

357+
AstroTheme
358+
359+
The default colorscheme used by AstroNvim an aesthetically pleasing and
360+
feature-rich neovim config that is extensible and easy to use with a great set
361+
of plugins
362+
363+
This module can be loaded with `local astrotheme = require "astrotheme"`
364+
365+
copyright 2023 license GNU General Public License v3.0 @class astrocore
366+
356367

357368
CONFIG ~
358369

@@ -381,9 +392,27 @@ Set up AstroTheme with provided user configured options
381392

382393
ASTROTHEME.LIB.COLOR *astrotheme-lua-api-astrotheme.lib.color*
383394

395+
AstroTheme Configuration
396+
397+
Default configuration of AstroTheme
398+
399+
This module can be loaded with `local astrotheme_config = require
400+
"astrotheme.lib.color"`
401+
402+
copyright 2023 license GNU General Public License v3.0 @class astrocore
403+
384404

385405
ASTROTHEME.LIB.CONFIG *astrotheme-lua-api-astrotheme.lib.config*
386406

407+
AstroTheme Configuration
408+
409+
Default configuration of AstroTheme
410+
411+
This module can be loaded with `local astrotheme_config = require
412+
"astrotheme.lib.config"`
413+
414+
copyright 2023 license GNU General Public License v3.0 @class astrocore
415+
387416

388417
DEFAULT ~
389418

@@ -402,6 +431,15 @@ USER_CONFIG ~
402431

403432
ASTROTHEME.LIB.UTIL *astrotheme-lua-api-astrotheme.lib.util*
404433

434+
AstroTheme Utilities
435+
436+
Various utilities for use within AstroTheme
437+
438+
This module can be loaded with `local astrotheme_utils = require
439+
"astrotheme.lib.util"`
440+
441+
copyright 2023 license GNU General Public License v3.0 @class astrocore
442+
405443

406444
GET_HIGHLIGHTS ~
407445

@@ -479,6 +517,14 @@ SET_TERMINAL_COLORS ~
479517

480518
Set terminal colors based on the currently loaded colors
481519

520+
==============================================================================
521+
2. Links *astrotheme-links*
522+
523+
1. *@class*:
524+
2. *@class*:
525+
3. *@class*:
526+
4. *@class*:
527+
482528
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
483529

484530
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)