Skip to content

Documentation Commands

rcli provides a set of subcommands under docs for managing your documentation.

init

rcli docs init

Creates a new documentation project in the current directory. This command initializes the project structure and files necessary to start writing your documentation.

dev

rcli docs dev

Starts a live-reloading server for your documentation, allowing you to view your changes in real time as you edit your documents. This is particularly useful during the development phase of your documentation to ensure immediate feedback on your changes.

build

rcli docs build

Builds your documentation site. This command processes your markdown files and generates a static site in the ./site directory, ready to be deployed to your hosting solution.

clean

rcli docs clean

Cleans up artifacts created during the build process. This is useful for cleaning your workspace by removing the ./site directory generated after building your documentation.