Skip to content

Sea-Grapes/svdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

137 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Svdown

A modern markdown preprocessor for Svelte (WIP). Focused on providing extremely easy markdown usage with minimal config needed.

Feature Goals:

  • comprehensive content-authoring experience for blogging, docs, etc.
  • tightly integrated markdown and Svelte
  • support for any (hopefully) remark/rehype plugins (including Latex)
  • image processing (enhanced-img, relative urls)
  • headings, table of contents, custom components
  • built-in code highlighters

Experimental

  • route or file-based layouts, state-based layouts/fm, fm process func

Inspired by MDsveX!

Installing

Note: package still in active development.

pnpm i -D svdown

Add it to your svelte.config.js:

import { markdown } from 'svdown'

/** @type {import('@sveltejs/kit').Config} */
const config = {
  extensions: ['.svelte', '.md'],
  preprocess: [vitePreprocess(), markdown()],
}

About

A markdown preprocessor for Svelte. (WIP)

Resources

License

Stars

1 star

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors