Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pngwn/mdsvex-template
A simple template for mdsvex with SvelteKit
https://github.com/pngwn/mdsvex-template
Last synced: 2 months ago
JSON representation
A simple template for mdsvex with SvelteKit
- Host: GitHub
- URL: https://github.com/pngwn/mdsvex-template
- Owner: pngwn
- Created: 2021-05-31T14:09:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2021-05-31T18:51:21.000Z (over 3 years ago)
- Last Synced: 2024-04-24T09:24:07.592Z (8 months ago)
- Language: Svelte
- Size: 11.7 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# mdsvex-template
A simple template to get started with mdsvex. This uses [SvelteKit](https:kit/svelte.dev). Anything you can do with kit, you can do with this.
## Creating a project
Clone this repo, or use GitHub's green 'Use this template' button in the top right or use [`degit`](https://github.com/Rich-Harris/degit).
```bash
npx degit pngwn/mdsvex-template#main my-project
```
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
npm run dev
# or start the server and open the app in a new browser tab
npm run dev -- --open
```
## Building
Before creating a production version of your app, install an [adapter](https://kit.svelte.dev/docs#adapters) for your target environment. Then:
```bash
npm run build
```
> You can preview the built app with `npm run preview`, regardless of whether you installed an adapter. This should _not_ be used to serve your app in production.