https://github.com/torstendittmann/svelte-markdoc-preprocess
Bring the power of Markdoc right into your Svelte applications!
https://github.com/torstendittmann/svelte-markdoc-preprocess
markdoc svelte
Last synced: about 1 year ago
JSON representation
Bring the power of Markdoc right into your Svelte applications!
- Host: GitHub
- URL: https://github.com/torstendittmann/svelte-markdoc-preprocess
- Owner: TorstenDittmann
- License: mit
- Created: 2023-07-19T01:51:44.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-20T13:15:39.000Z (about 1 year ago)
- Last Synced: 2025-03-29T06:04:55.142Z (about 1 year ago)
- Topics: markdoc, svelte
- Language: TypeScript
- Homepage: https://svelte-markdoc-preprocess.pages.dev
- Size: 1.45 MB
- Stars: 67
- Watchers: 1
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
svelte-markdoc-preprocess
Bring the power of Markdoc right into your Svelte applications!
Explore the docs »
   
## Table Of Contents
- [Getting Started](#getting-started)
- [Installation](#installation)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Authors](#authors)
- [Acknowledgements](#acknowledgements)
## Getting Started
### Installation
1. Install the package:
```sh
npm i -D svelte-markdoc-preprocess
```
2. Add the preprocessor and new extensions to your svelte.config.js:
```js
import { markdoc } from 'svelte-markdoc-preprocess';
const config = {
preprocess: [vitePreprocess(), markdoc()],
extensions: ['.markdoc', '.svelte'],
};
```
3. Use it
```md
# I am a heading
I am a paragraph with **bold** words. But you can also use Svelte Components:
```
## Roadmap
See the [open issues](https://github.com/torstendittmann/svelte-markdoc-preprocess/issues) for a list of proposed features (and known issues).
## Contributing
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
- If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/torstendittmann/svelte-markdoc-preprocess/issues/new) to discuss it, or directly create a pull request after you edit the _README.md_ file with necessary changes.
- Please make sure you check your spelling and grammar.
- Create individual PR for each suggestion.
- Please also read through the [Code Of Conduct](https://github.com/torstendittmann/svelte-markdoc-preprocess/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
### Creating A Pull Request
1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request