Skip to content
/ bitmd Public

๐Ÿ“ƒ A pluggable markdown editor/viewer built with marked.

License

Notifications You must be signed in to change notification settings

mivinci/bitmd

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

10 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

BitMD

๐Ÿ“ƒ A pluggable markdown editor/viewer built with marked.

screenshot

BitMD is being developed using bun as the package manager and vite as the package bundler which's cool :)

Features

  • Support for multiple frameworks, themes and locales.
  • Compatible with existing marked extensions

Examples

For VanillaJS,

new bitmd.BitMD({
  target: document.querySelector("#app"),
  props: {
  value: "# Heading",
    plugins: [
      bitmd_plugin_katex(),
      bitmd_plugin_highlight(),
    ]
  }
});

Check out examples/vanilla for the full code snippet.

Plugins & Bindings

Here are plugins or bindings finished or being planned.

Develop

To develop, make sure you have bun installed on your device.

git clone https://github.com/mivinci/bitmd.git
cd bitmd
bun i

Credits

License

BitMD is MIT licensed.

Have fun :)