Installation

Use create-shiso-app to start a new Shiso site. The generator creates a small project that installs the upgradeable @umami/shiso framework dependency.

Create a project#

Choose the command for your package manager:

pnpm dlx create-shiso-app@latest my-docs

Replace my-docs with your project directory. The directory must be empty if it already exists.

The generator:

• Copies a minimal Shiso starter site
• Installs Shiso as a regular project dependency
• Sets the package name from the project directory
• Installs dependencies with the package manager that invoked it
• Initializes a fresh Git repository on the main branch
• Adds no Git remote, so the project is not tied to the Shiso repository

Start the site#

Move into the generated project and start the development server:

cd my-docs
pnpm dev

Open the local URL shown in your terminal. Edit content/docs/index.mdx to change the first page and docs.json to configure the site and navigation.

Upgrade Shiso#

The generator is only used to create the project. Upgrade the framework later through your package manager:

pnpm update @umami/shiso

This installs the newest version allowed by the range in package.json. When the range does not allow the newest release, update the dependency explicitly (e.g. pnpm add @umami/shiso@latest), then run pnpm check and pnpm build to verify the upgrade.

Your content, docs.json, styles.css, and files under public remain in your project; rendering and build internals update with the dependency.

CLI options#

Run create-shiso-app --help to see every option.

Next step#

Continue to Configuration to customize docs.json, or Writing content to add pages and components.