neovim/doc

Generated documentation and reports

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.
  • GitHub implicitly creates a website from that branch, mapped to the /doc/ path of the main website.
• Some assets are served at https://neovim.io/doc
  • doc/ landing page
    • user/ docs
  • Build reports:
    • Vimpatch report

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

Example: Generate the vim-patch report:

VIM_SOURCE_DIR=~/vim-src/ NEOVIM_DIR=~/neovim-src/ ./ci/vimpatch-report.sh