Giter VIP home page Giter VIP logo

muya's Introduction

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.

๐Ÿ…ฐ๏ธ 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

muya's People

Contributors

jocs avatar fxha avatar gideonsenku avatar bensengupta avatar chungzh avatar dependabot[bot] avatar neopostmodern avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.