mirror of
https://github.com/neovim/doc.git
synced 2026-11-17 02:41:18 +00:00
Generated documentation and reports
- HTML 50.3%
- Shell 49.7%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
| .github | ||
| ci | ||
| templates | ||
| .gitignore | ||
| LICENSE | ||
| README.md | ||
doc/: Generated docs and reports for Neovim
Warning
This repo is no longer needed since https://github.com/neovim/neovim.github.io/pull/437.
Instead the website repo (
neovim/neovim.github.io), plus scripts inneovim/neovim, generate reports as needed.
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.
- GitHub implicitly creates a website from that branch, mapped to the
/doc/path of the main website.
- GitHub implicitly creates a website from that branch, mapped to the
- Some assets are served at https://neovim.io/doc
Run Locally
To run the scripts locally, execute ./ci/<build script>, 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