svem

KO | EN

gitlite — search

#javascript #python #hacktoberfest #react #ai #typescript #llm #go #golang #android #machine-learning #rust #deep-learning #linux

★ 14 Open GitHub ↗

Svelte in Markdown preprocessor

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Svem

Svem is a preprocessor for Svelte in Markdown. It allows you to write Svelte components in Markdown files. Insipired by Vitepress, Svem aims to provide a simple and easy way to write Svelte components in Markdown files.

[![Preview](https://beerush-id.github.io/svem/images/preview.jpg)](https://beerush-id.github.io/svem/images/preview.webm)

## Installation

```bash
bun add -d svem
```

## Usage

To use Svem, update your `svelte.config.js` file to to include `svem` in the preprocess array.

```javascript
import adapter from '@sveltejs/adapter-cloudflare';
import { vitePreprocess } from '@sveltejs/vite-plugin-svelte';
import { svem } from 'svem';

const config = {
	preprocess: [vitePreprocess(), svem()],
	kit: {
		adapter: adapter()
	},
	extensions: ['.svelte', '.svem', '.svx']
};

export default config;
```

## Features

- Supports Svelte syntax highlighting.
- Supports markdown syntax highlighting.
- Write Svelte components in Markdown files.
- Frontmatter.
- Code blocks.
- Code highlighting (using Shiki).
- Inline code highlighting.
- Code group blocks
- Code preview blocks
- Callout blocks (tip, note, important, warning, caution).
- Layouts.
- Heading links generation and injection.

> Note:
> Only one script tag is allowed in a Svem file.

To make working with Svem easier, you can use the [Svem VSCode extension](https://marketplace.visualstudio.com/items?itemName=beerush.svem). It provides syntax highlighting, snippets, and basic intellisense for Svem files.

svem

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README