https://github.com/neovim/doc
Generated documentation and reports
https://github.com/neovim/doc
neovim
Last synced: about 2 months ago
JSON representation
Generated documentation and reports
- Host: GitHub
- URL: https://github.com/neovim/doc
- Owner: neovim
- License: apache-2.0
- Created: 2014-06-26T20:47:35.000Z (almost 11 years ago)
- Default Branch: main
- Last Pushed: 2024-10-29T05:21:19.000Z (8 months ago)
- Last Synced: 2024-10-29T15:13:53.557Z (8 months ago)
- Topics: neovim
- Language: HTML
- Homepage: neovim.github.io/doc/
- Size: 11.7 MB
- Stars: 34
- Watchers: 14
- Forks: 13
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# doc/: Generated docs and reports for Neovim
This repo contains automation scripts and CI configuration to run the scripts.
- The CI job runs the scripts which generate stuff, which is committed to the
[**gh-pages** branch](https://github.com/neovim/doc/tree/gh-pages).
- GitHub implicitly creates a website from that branch, mapped to the
`/doc/` path of the [main website](https://github.com/neovim/neovim.github.io).
- Some assets are served at https://neovim.io/doc
- [doc/ landing page](https://neovim.io/doc)
- [user/ docs](https://neovim.io/doc/user)
- Build reports:
- [Vimpatch report](https://neovim.io/doc/reports/vimpatch)
## Run Locally
To run the scripts locally, execute `./ci/`, where `build script`
is any executable shell script. Override environment variables as necessary.
### Example: Build user documentations:
NEOVIM_DIR=~/neovim-src/ ./ci/user-docu.sh
### Example: Generate the vim-patch report:
VIM_SOURCE_DIR=~/vim-src/ NEOVIM_DIR=~/neovim-src/ ./ci/vimpatch-report.sh