holydocs init
Scaffold a new HolyDocs project with starter pages and a docs config.
Usage
bashholydocs init [options]
Creates a new local docs project by writing docs.json plus starter MDX files in the target directory.
Options
| Option | Description | Default |
|---|---|---|
--template <id> | Starter template: blank, api-docs, product-docs, or open-source | Prompted |
--dir <path> | Directory to initialize | Current directory |
Templates
| Template | Description |
|---|---|
blank | Minimal starter with a single introduction page |
api-docs | API docs starter with intro, quickstart, auth, and API reference pages |
product-docs | Product documentation starter with guides |
open-source | Open source starter with installation, contributing, and changelog pages |
Examples
Interactive Setup
bashholydocs init
You will be prompted for:
- Template selection
- Project name
Choose a Template Up Front
bashholydocs init --template api-docs
Initialize in a Subdirectory
bashholydocs init --template product-docs --dir ./docs
What Gets Created
Every template writes:
docs.json- One or more starter
.mdxpages - Nested content directories when needed, such as
guides/orapi-reference/
Existing Projects
If docs.json already exists in the target directory, holydocs init warns and asks whether you want to overwrite it.
Suggested Next Steps
bashholydocs devholydocs checkholydocs deploy
holydocs init writes into the directory you point it at. Create the directory first if you want a fresh folder, for example mkdir my-docs && cd my-docs && holydocs init.