# Installation
First install the plugin:
npm install lore-kitthen, in svelte.config.js, update preprocessors and extensions fields:
import { lore } from 'lore-kit'
export const config = {
preprocess: [lore()],
extensions: ['.svelte', '.md']
}and in the root css of your project, i.e. app.css, import the plugin styles:
@import 'tailwindcss'; /* tailwind comes with lore */
@import 'lore-kit/layout.css';
@source "../node_modules/lore-kit/dist";# Usage
Instead of +page.svelte files, you write +page.md files. Then you can do pretty much
everything you would in a normal markdown file. But also anything you would in
a normal svelte file, like this:
<script>
import FancyComponent from './FancyComponent.svelte'
let counter = $state(0)
</script>
# Title
Some description under the title here!
## Section
A **counter**!
<button onclick={() => counter++}>{counter}</button>
And a svelte component
<FancyComponent />
Or some maths :O
$$f(a) = \frac{1}{2\pi i} \oint_{\gamma}\frac{f(z)}{z-a} dz.$$# Frontmatter
At the start of each +page.md file you can specify author and github fields:
---
github: user/repo
author: user
---In markdown, relative links will be relative to the repo link. So, for example
[script](./script.py) will point to file script.py inside the repo user/repo on github. The same applies to images.