@sveltek/markdown

Svelte Markdown Preprocessor.

Note

While the API is solid and mostly complete, some changes may still occur before the first stable release.

Ideas, suggestions and code contributions are welcome.

If you find any issues or bugs, please report them so the project can be improved.

Core Concepts

• Custom Components: Simplifies development by supporting import/export of reusable components.
• Named Layouts: Provides a powerful named layout mechanism to completely customize page design.
• Unique Entries: Defines specialized, entry-level configuration adapted for all markdown files.
• Unified Plugins: Enables content transformation using widely-adopted tools like remark and rehype.
• Global Frontmatter: Streamlines workflow by offering centralized options for markdown metadata.
• Global Components: Defines global components that can be used in all markdown files without manual setup.
• Special Elements: Supports parsing Svelte special elements such as svelte:head etc. in markdown files.
• Code Highlighter: Offers quick and easy customization for syntax highlighting.

Documentation

Everything you need for a quick start.

Contribute

Check out the quick guide for more info.

License

Developed in 🇭🇷 Croatia, © Sveltek.

Released under the MIT license.