Skip to content

Repository files navigation

MDZip logo

mdzip-editor

@mdzip/editor on npm license

Reusable JavaScript, Angular, React, and Vue workspace packages for Markdown and MDZip files.

Packages

  • npm @mdzip/editor is the framework-independent workspace engine built on @mdzip/core-js.
  • npm @mdzip/editor-ng is the Angular component wrapper for the workspace engine.
  • npm @mdzip/editor-react is the React component wrapper.
  • npm @mdzip/editor-vue is the Vue 3 component wrapper.

The interactive demo (raw JS, Angular, React, and Vue tabs proving the packages run outside VS Code) lives in mdzip.org's editor-demo/app, not in this repo — see private/Publish.mdz §2 for testing local editor changes against it before publishing.

Development

npm install
npm run build
npm test

Using The Library

See docs/developer-guide.md for standalone and hosted usage, granular toolbar configuration, and framework examples.

See docs/theming.md for custom themes and the complete CSS variable reference.

About

A reusable JavaScript, Angular, React and Vue viewer/editor for Markdown and MDZip (.mdz) files

Topics

Resources

Stars

Watchers

Forks

Releases

Contributors

Languages