Commands
sourcey init
Start a Sourcey project, with the specs and Doxygen setup it finds beside it.
sourcey init asks a few questions and writes a project you can run straight away.
npx sourcey init
npm install
npx sourcey devIt asks for:
- A folder, when run inside an existing project (one with a
package.json,.gitorsrc):docs, ordocumentationifdocsis taken. - The project's name, which defaults to the folder's.
- A theme:
default,minimal,api-firstorreader. See Themes. - An API reference from an OpenAPI spec it finds in the folder, and a Doxygen reference from a
Doxyfileit finds there, each if you want it. - Example content, a quickstart page, when it found neither.
It writes sourcey.config.ts, introduction.md (and quickstart.md with example content), a package.json with dev and build scripts and Sourcey as a dependency, and a .gitignore for node_modules and dist. An existing package.json or .gitignore is left alone, and a folder that already has a sourcey.config.ts is refused.
