Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
astronvimbot committed Jul 12, 2024
1 parent 05223f0 commit 1943ed2
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions doc/astrotheme.txt
Original file line number Diff line number Diff line change
Expand Up @@ -310,6 +310,31 @@ CONTRIBUTING *astrotheme-contributing*
If you plan to contribute, please check the contribution guidelines
<https://github.com/AstroNvim/.github/blob/main/CONTRIBUTING.md> first.

When contributing to the extras, we use a templating system for automatically
generating extra files for all of the different color palettes. Here are some
steps to get started:

1. Create a file like `lua/astrotheme/extras/cool-app.lua`


2. Add the name and output file extension to the `extras` table in
`lua/astrotheme/extra/init.lua`


3. Generate the new extra theme files by running the following command in the root
of the repository:

>sh
make extras
<


4. Verify the new templates are working by checking the generated files in the
`extras/` directory. Please **DO NOT** commit them, as they get automatically
built by the CI.




==============================================================================
1. Lua API *astrotheme-lua-api*
Expand Down

0 comments on commit 1943ed2

Please sign in to comment.