Config overview

Pre-requisites

ripgrep and fd are installed on the system

• ripgrep - grep replacement

• fd - find replacement

Config as a sphinx project

This is also a python project, primarily for generating sphinx docs, with uv driving the workflow.

• Run uv sync to create a python virtual environment with all dependencies installed.

• Run uv run nvim-config --help to see available commands for generating docs.

  $ uv run nvim-config --help
  Usage: nvim-config [OPTIONS] COMMAND [ARGS]...
  
  Options:
    --install-completion [bash|zsh|fish|powershell|pwsh]
                                    Install completion for the specified shell.
    --show-completion [bash|zsh|fish|powershell|pwsh]
                                    Show completion for the specified shell, to
                                    copy it or customize the installation.
    --help                          Show this message and exit.
  
  Commands:
    info
    docs
    live
    clean
    init-docs
  

• A wrapper Makefile is present to keep the typing to a minimum

  $ make
  clean                          Clean generated docs
  docs                           Generate docs
  format                         Run stylua for all files in the lua directores
  help                           Show this help
  live                           Generate live docs