{"id":13725927,"url":"https://github.com/marktext/muya","last_synced_at":"2025-05-14T20:07:56.473Z","repository":{"id":39916621,"uuid":"139091338","full_name":"marktext/muya","owner":"marktext","description":"📄 Future markdown editor for web browser applications development","archived":false,"fork":false,"pushed_at":"2025-04-11T14:07:50.000Z","size":4975,"stargazers_count":671,"open_issues_count":24,"forks_count":58,"subscribers_count":22,"default_branch":"master","last_synced_at":"2025-05-13T23:13:40.993Z","etag":null,"topics":["markdown","markdown-editor"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/marktext.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"docs/ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2018-06-29T02:30:54.000Z","updated_at":"2025-04-28T08:55:32.000Z","dependencies_parsed_at":"2023-09-23T13:19:35.287Z","dependency_job_id":"3953edfa-ab68-4e93-84d3-5e8ce5353f98","html_url":"https://github.com/marktext/muya","commit_stats":{"total_commits":477,"total_committers":13,"mean_commits":36.69230769230769,"dds":0.5031446540880503,"last_synced_commit":"5f3cbbbcbab79be8d3d7ad9a02035f0e1ae25480"},"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marktext%2Fmuya","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marktext%2Fmuya/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marktext%2Fmuya/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/marktext%2Fmuya/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/marktext","download_url":"https://codeload.github.com/marktext/muya/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254219373,"owners_count":22034397,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-editor"],"created_at":"2024-08-03T01:02:41.421Z","updated_at":"2025-05-14T20:07:56.453Z","avatar_url":"https://github.com/marktext.png","language":"TypeScript","readme":"\u003cp  align=\"center\"\u003e\u003cimg  src=\"./docs/logo.jpg\"  alt=\"muya\"  height=\"150\"\u003e\u003c/p\u003e\n\n**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.\n\n:a: Muya is still under development and should not be used for production.\n\n## Installing\n\n```sh\nnpm install @muyajs/core\n```\n\n## Quick Start\n\n```typescript\nimport {\n    CodeBlockLanguageSelector,\n    EmojiSelector,\n    ImageResizeBar,\n    ImageToolBar,\n    InlineFormatToolbar,\n    MarkdownToHtml,\n    Muya,\n    ParagraphFrontButton,\n    ParagraphFrontMenu,\n    ParagraphQuickInsertMenu,\n    PreviewToolBar,\n    TableColumnToolbar,\n    TableDragBar,\n    TableRowColumMenu,\n    zh,\n} from '@muyajs/core';\n\nMuya.use(EmojiSelector);\nMuya.use(InlineFormatToolbar);\nMuya.use(ImageToolBar);\nMuya.use(ImageResizeBar);\nMuya.use(CodeBlockLanguageSelector);\n\nMuya.use(ParagraphFrontButton);\nMuya.use(ParagraphFrontMenu);\nMuya.use(TableColumnToolbar);\nMuya.use(ParagraphQuickInsertMenu);\nMuya.use(TableDragBar);\nMuya.use(TableRowColumMenu);\nMuya.use(PreviewToolBar);\n\nimport '@muyajs/core/lib/style.css';\n\nconst container = document.querySelector('#editor');\nconst muya = new Muya(container, {\n    markdown: 'Hello world',\n});\n\nmuya.locale(zh);\n\nmuya.init();\n```\n\nThere is also an [example](https://github.com/marktext/muya/tree/master/examples) of how to use muya in Typescript.\n\n## Documents\n\nComing soon!!!\n\n## Development\n\n[commit-msg-guideline](https://github.com/angular/angular/blob/master/CONTRIBUTING.md#-commit-message-guidelines)\n\n```sh\n# step1: install dependencies\npnpm install\n# step2: run the development codes\npnpm run dev\n```\n\n## Build\n\n```sh\npnpm build\n```\n\n## publish\n\n```sh\n# update version numbers.\npnpm run release\n# publish to npm.\npnpm -r publish\n```\n\n## FAQ\n\n❓ **What is the relationship between MarkText and Muya?**\n\nMuya 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.\n\n❓**What is the relationship between MarkText's version and the Muya's version?**\n\nNone!\n\n## Built with muya\n\n- [MarkText](https://github.com/marktext/marktext) - Next generation markdown editor, running on platforms of MacOS Windows and Linux.\n\n- [MindBox](https://www.mindbox.cc/) - A note-taking app that perfectly supports markdown syntax.\n\n## License\n\nMIT © [Jocs](https://github.com/Jocs)\n","funding_links":[],"categories":["JavaScript","TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarktext%2Fmuya","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarktext%2Fmuya","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarktext%2Fmuya/lists"}