Documentor

A Svelte component to create beautiful documentation websites.

---

create-svelte

Everything you need to build a Svelte library, powered by create-svelte.

Read more about creating a library in the docs.

$3

If you're seeing this, you've probably already done this step. Congrats!

``bash


create a new project in the current directory

pnpm create svelte@latest

create a new project in my-app

pnpm create svelte@latest my-app
`

$3

Once you've created a project and installed dependencies with pnpm install (or ppnpm install or yarn), start a development server:

`bash
pnpm dev

or start the server and open the app in a new browser tab


pnpm dev--open
`

Everything inside src/lib is part of your library, everything inside src/routes can be used as a showcase or preview app.

$3

To build your library:

`bash
pnpm package
`

To create a production version of your showcase app:

`bash
pnpm build
`

You can preview the production build with pnpm run preview.

> To deploy your app, you may need to install an adapter for your target environment.

$3

Go into the package.json and give your package the desired name through the "name" option. Also consider adding a "license" field and point it to a LICENSE file which you can create from a template (one popular option is the MIT license).

To publish your library to npm:

`bash
pnpm publish
``