https://github.com/pngwn/MDsveX

A markdown preprocessor for Svelte.
https://github.com/pngwn/MDsveX

Last synced: about 2 months ago
JSON representation

A markdown preprocessor for Svelte.

• Host: GitHub
• URL: https://github.com/pngwn/MDsveX
• Owner: pngwn
• License: mit
• Created: 2019-01-09T18:13:51.000Z (almost 6 years ago)
• Default Branch: main
• Last Pushed: 2024-10-07T03:04:27.000Z (2 months ago)
• Last Synced: 2024-10-13T00:34:33.275Z (2 months ago)
• Language: JavaScript
• Homepage: https://mdsvex.pngwn.io
• Size: 7.67 MB
• Stars: 2,368
• Watchers: 18
• Forks: 102
• Open Issues: 142
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-remark - mdsvex - Markdown preprocessor for Svelte. (Built on remark)
• awesome-svelte - MDSveX - Preprocessor for MDX markdown. (Integrations / Preprocessing)
• awesome - pngwn/MDsveX - A markdown preprocessor for Svelte. (JavaScript)
• awesome - pngwn/MDsveX - A markdown preprocessor for Svelte. (JavaScript)

README

        
# mdsvex

A Markdown preprocessor for Svelte. Markdown in Svelte.

[mdsvex.com](https://mdsvex.com)

## Packages

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

- [site](https://github.com/pngwn/MDsveX/tree/master/packages/site) - The documentation website.

- [mdsvex](https://github.com/pngwn/MDsveX/tree/master/packages/mdsvex) - `mdsvex` itself.

- [svelte-parse](https://github.com/pngwn/MDsveX/tree/master/packages/svelte-parse) - Generate a svast AST from a Svelte components.

- [svast](https://github.com/pngwn/MDsveX/tree/master/packages/svast) - An AST specification with accompanying TypeScript definitions.

- [svast-stringify](https://github.com/pngwn/MDsveX/tree/master/packages/svast-stringify) - Turn a svast AST into a Svelte component.

- [svast-utils](https://github.com/pngwn/MDsveX/tree/master/packages/svast-utils) - Utilities for working with a svast tree.

## Contributing

Contributions are welcome. This repo uses [changesets](https://github.com/atlassian/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).