Skip to content

Installation

How to install and set up the documentation starter.

1 min read

Prerequisites

Make sure you have the following installed:

  • Node.js 18 or later
  • npm, pnpm, or yarn

Create a New Project

Clone the template and install dependencies:

npx degit codegio/svelte-docs-starter my-docs
cd my-docs
npm install

Start the Dev Server

npm run dev

Your docs site will be running at http://localhost:5173.

Project Structure

After installation, your project will look like this:

my-docs/
├── src/
│   ├── content/docs/     # Your markdown files
│   ├── lib/
│   │   ├── components/   # UI components
│   │   └── docs/         # Docs engine (config, content loader, nav)
│   └── routes/           # SvelteKit routes
├── svelte.config.js
├── vite.config.ts
└── package.json

Next Steps