https://github.com/mivinci/bitmd

📃 A pluggable markdown editor/viewer built with marked.
https://github.com/mivinci/bitmd

bun markdown markdown-editor react svelte vite vue

Last synced: 1 day ago
JSON representation

📃 A pluggable markdown editor/viewer built with marked.

• Host: GitHub
• URL: https://github.com/mivinci/bitmd
• Owner: mivinci
• License: mit
• Created: 2024-02-09T10:09:05.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-03-30T07:12:38.000Z (6 months ago)
• Last Synced: 2024-03-30T08:23:19.437Z (6 months ago)
• Topics: bun, markdown, markdown-editor, react, svelte, vite, vue
• Language: TypeScript
• Homepage:
• Size: 420 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# BitMD

📃 A pluggable markdown editor/viewer built with [marked](https://marked.js.org).

![screenshot](./docs/screenshot.png)

BitMD is being developed using [bun](https://bun.sh) as the package manager and [vite](https://vitejs.dev) as the package bundler which's cool :)

## Features

- Support for multiple frameworks, themes and locales.

- Compatible with existing [marked extensions](https://marked.js.org/using_advanced#extensions)

## Examples

For VanillaJS,

```js

new bitmd.BitMD({

  target: document.querySelector("#app"),

  props: {

  value: "# Heading",

    plugins: [

      bitmd_plugin_katex(),

      bitmd_plugin_highlight(),

    ]

  }

});

```

Check out [examples/vanilla](./examples/vanilla/index.html) for the full code snippet. 

## Plugins & Bindings

Here are plugins or bindings finished or being planned.

- [x] [plugin-gfm](./packages/plugin-gfm/) - GitHub flavored markdown

- [x] [plugin-image](./packages/plugin-image/) - Image upload and insertion

- [x] [plugin-katex](./packages/plugin-katex/) - LaTeX math formulas

- [x] [plugin-highlight](./packages/plugin-highlight/) - Code highlighting

- [ ] [plugin-mermaid](./packages/plugin-mermaid/) - Mermaid graghs and charts

- [ ] [react](./packages/react/) - React binding of BitMD

- [ ] [vue](./packages/vue/) - Vue binding of BitMD

## Develop

To develop, make sure you have [bun](https://bun.sh) installed on your device.

```bash

git clone https://github.com/mivinci/bitmd.git

cd bitmd

bun i

```

## Credits

- [marked](https://marked.js.org)

- [bytemd](https://bytemd.js.org)

## License

BitMD is MIT licensed.

##

Have fun :)