https://github.com/enpitsulin/sanity-plugin-milkdown

A Markdown editor for Sanity Studio with preview supported by Milkdown
https://github.com/enpitsulin/sanity-plugin-milkdown

markdown markdown-editor sanity sanity-studio

Last synced: 24 days ago
JSON representation

A Markdown editor for Sanity Studio with preview supported by Milkdown

• Host: GitHub
• URL: https://github.com/enpitsulin/sanity-plugin-milkdown
• Owner: enpitsuLin
• License: mit
• Created: 2023-01-05T01:57:19.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T01:41:40.000Z (almost 2 years ago)
• Last Synced: 2024-10-20T06:47:48.969Z (about 1 month ago)
• Topics: markdown, markdown-editor, sanity, sanity-studio
• Language: TypeScript
• Homepage:
• Size: 389 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# sanity-plugin-milkdown

## What is it

A Markdown editor for Sanity Studio with preview supported by [Milkdown](https://github.com/Saul-Mirone/milkdown) which was a alternatives to official plugin `sanity-plugin-markdown`

## Installation

```sh

npm install sanity-plugin-milkdown --save

```

or

```sh

pnpm add sanity-plugin-milkdown

```

## Usage

Add it as a plugin in `sanity.config.ts` (or .js):

```ts

import {defineConfig} from 'sanity'

import {markdownSchema} from 'sanity-plugin-milkdown'

export default defineConfig({

  //...

  plugins: [markdownSchema({})],

})

```

## Demo

![milkdowndemo](https://user-images.githubusercontent.com/29378026/210738213-634e2c1f-5fcc-4717-95f1-adb23925e56a.gif)

## License

[MIT](LICENSE) © enpitsulin

## Develop & test

This plugin uses [@sanity/plugin-kit](https://github.com/sanity-io/plugin-kit)

with default configuration for build & watch scripts.

See [Testing a plugin in Sanity Studio](https://github.com/sanity-io/plugin-kit#testing-a-plugin-in-sanity-studio)

on how to run this plugin with hotreload in the studio.