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.

Creating a project

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

# 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

Developing

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

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.

Building

To build your library:

pnpm package

To create a production version of your showcase app:

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.

Publishing

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:

pnpm publish