For AI agents: the documentation index is at llms.txt. Markdown versions are available by appending .md to any page URL, including this page's markdown.
edda new
Scaffold a new Edda docs site with docs.json and an index.mdx starter page, either in the current folder or a docs subdirectory.
Create a starter documentation directory with a docs.json configuration file and an index.mdx page.
edda new [directory]Interactive edda new inspects the current directory first:
- If the current directory is empty, it scaffolds there and prompts for the project slug.
- If the current directory is not empty, it asks whether to create the docs in a subdirectory or scaffold the current directory.
- If prompts are skipped with
--yesor in a non-interactive environment, it falls back todocs/.
What it creates
If you create the docs in a docs/ subdirectory, edda new generates the following file tree:
docs.json
The generated configuration uses the hosted Edda schema and a single "Getting Started" navigation group. The slug field comes from the slug prompt, --slug, or a derived default. The name field defaults to a title-cased display name based on that slug unless you pass --display-name.
Published with Edda