@marktext/muya

Muya originated from MarkText, which was originally used in the MarkText and provides Markdown editing support for MarkText. Today, Muya is available as a stand-alone library that provides an efficient Markdown editing experience for many web browser applications.

:a: Muya is still under development and should not be used for production.

Installing

yarn add @marktext/muya

Usage

import Muya from '@marktext/muya'

const container = document.querySelector('#editor')
const muya = new Muya(container)

Documents

Coming soon!!!

Development

commit-msg-guideline

# step1: install dependencies
yarn
# step2: run the development codes
yarn dev

Build

yarn build

publish

# update version numbers
npm run pub

FAQ

❓ What is the relationship between MarkText and Muya?

Muya is derived from MarkText. Our team believes that Muya should not be limited to desktop applications. It should also run in a web browser, so we have done some compatibility with browsers and Electron applications, so that Muya can leave Electron Apps and can run into different browser environments.

❓What is the relationship between MarkText's version and the Muya's version?

None!

Built with muya

• MarkText - Next generation markdown editor, running on platforms of MacOS Windows and Linux.

• MindBox - A note-taking app that perfectly supports markdown syntax.

License

MIT © Jocs