MDsveX README

The project's README from github.com/pngwn/MDsveX. As one markdown file: README.md.

mdsvex

A Markdown preprocessor for Svelte. Markdown in Svelte.

mdsvex.com

Packages

This is a monorepo containing mdsvex and any supporting packages. Each repo has its own readme with more details.

Contributing

Contributions are welcome. This repo uses changesets to manage changelogs and versioning. All pull requests need an accompanying changeset file (PRs to the documentation website do not need a changeset file). If you know how changesets work then feel free to add one with the appropriate packages, versions and a description of the change. If you don't know how changesets work, don't worry about it, I am happy to add one (a little robot will also add some details to the PR when you open it as well, if you want to learn more).

MDsveX (pngwn/MDsveX)

Searching Database…

3.1K ·GitHub
Что это такое?mdsvex — это препроцессор Markdown для Svelte: он позволяет писать Markdown внутри проектов Svelte и на этапе сборки превращает его в компоненты Svelte.
Это библиотека, которую я добавляю в свой проект на Svelte, или отдельное приложение, которое я запускаю?Это библиотека: вы добавляете пакет mdsvex в проект на Svelte и подключаете его как препроцессор на этапе сборки — отдельного приложения для запуска нет.
Как добавить его в проект?Установите пакет mdsvex из npm как зависимость для разработки и зарегистрируйте его как препроцессор в конфиге Svelte; полный гайд по настройке есть на сайте документации mdsvex.com.
Я делаю блог или сайт с контентом на Svelte — что мне это даст?Вы пишете контент в Markdown и при этом используете компоненты Svelte в том же проекте; mdsvex компилирует Markdown в рамках сборки — это типичное решение для блогов на Svelte.
Что есть в репозитории, кроме самого mdsvex?Это монорепозиторий: помимо mdsvex там есть сайт документации, svelte-parse (превращает компоненты Svelte в AST-дерево svast), svast (спецификация AST с определениями типов для TypeScript), svast-stringify (превращает AST-дерево svast обратно в компонент Svelte) и svast-utils.
Что такое svast?Спецификация AST с определениями типов для TypeScript. Вокруг неё построены вспомогательные пакеты: svelte-parse создаёт дерево svast из компонентов Svelte, а svast-stringify превращает такое дерево обратно в компонент Svelte.
Мне нужно разбираться в компиляторах или AST, чтобы пользоваться этим?Нет — svast, svelte-parse, svast-stringify и svast-utils — это вспомогательные пакеты, работающие за кулисами; как пользователь вы просто добавляете препроцессор mdsvex в свой проект и пишете Markdown.
What are similar projects?babel, marked, acorn, markdown-it, mitosis, nextra, postcss, oxc
Creator
pngwn
Size
16.5 MB
Stars
3.1K
Age
7y
Commits · 90 Days