Skip to content

TGlide/svelte-markdoc-preprocess

 
 

Repository files navigation

svelte-markdoc-preprocess

This is a Svelte preprocessor that allows you to use Markdoc.

Features

  • Processor
  • Configuration
  • Svelte components
  • Auto Components Import from Layout
  • Frontmatter
  • Layouts
  • Tests

Installation

npm i -D svelte-markdoc-preprocess
// svelte.config.js
import { markdoc } from 'svelte-markdoc-preprocess';

const config = {
    preprocess: [
        vitePreprocess(),
        markdoc({
            layout: join(
                dirname(fileURLToPath(import.meta.url)),
                './src/lib/Layout.svelte',
            ),
        }),
    ],
    extensions: ['.markdoc', '.svelte'],
};
<!-- ./src/lib/Layout.svelte -->
<script context="module">
    export { default as Addition } from './Addition.svelte';
    export { default as MyTest } from './Test.svelte';
</script>

<slot />
<!--  page.markdoc -->

# I am a heading

I am a paragraph with **bold** words. But you can also use Svelte Components:

{% mytest /%}
{% addition a=4 b=6 /%}

Experimental

This is totally experimental for now, please don't use it. Even if you're a brave one.

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 52.2%
  • JavaScript 35.7%
  • Svelte 8.3%
  • HTML 3.8%