# marktext-muya

**Repository Path**: zhi/marktext-muya

## Basic Information

- **Project Name**: marktext-muya
- **Description**: No description available
- **Primary Language**: TypeScript
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2024-01-28
- **Last Updated**: 2024-03-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<p  align="center"><img  src="./public/logo.jpg"  alt="muya"  height="150"></p>



**Muya** originated from [MarkText](https://github.com/marktext/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

```sh
yarn add @marktext/muya
```

## Usage

```javascript
import Muya from '@marktext/muya'

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

## Documents

Coming soon!!!

## Development

[commit-msg-guideline](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)

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

## Build

```sh
yarn build
```

## publish

```sh
# 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](https://github.com/marktext/marktext) - Next generation markdown editor, running on platforms of MacOS Windows and Linux.

- [MindBox](https://www.mindbox.cc/) - A note-taking app that perfectly supports markdown syntax.

## License

MIT © [Jocs](https://github.com/Jocs)