Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/contentmunch/muncher
Muncher is a rich text editor based on Lexical with a focus on content reuse.
https://github.com/contentmunch/muncher
content-reuse muncher wysiwyg-editor
Last synced: about 2 months ago
JSON representation
Muncher is a rich text editor based on Lexical with a focus on content reuse.
- Host: GitHub
- URL: https://github.com/contentmunch/muncher
- Owner: contentmunch
- License: mit
- Created: 2023-10-08T02:25:03.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-01-31T20:29:46.000Z (12 months ago)
- Last Synced: 2024-10-10T19:20:58.756Z (3 months ago)
- Topics: content-reuse, muncher, wysiwyg-editor
- Language: TypeScript
- Homepage: https://www.muncher.dev/
- Size: 6.63 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Muncher
[Muncher](https://www.muncher.dev/) is a rich text editor based on [Lexical](https://lexical.dev/) with a focus on content reuse.
## Using Muncher
To use this component library:
* add the npm package to your project
```
$ npm install @contentmunch/muncher
```
## Installation guide
In the project directory, you can run:
### `npm start`
Launches the component explorer on port 6009
### `npm test`
Launches the test runner in the interactive watch mode.
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
### `npm run build`
Builds the package library.
## Coding rules
We use [GitHub Flow](https://guides.github.com/introduction/flow/) for our project workflow.
To ensure consistency throughout the source code, keep these rules in mind as you are working:
* Create pull request against develop to merge your code.
* All features or bug fixes **must be tested** by one or more [specs][unit-testing].
### Pull request format
```
* changes 1
* changes 2
fixes/closes #
```
### Git commit format
```
:
optional
```
* Any line of the commit message cannot be longer 100 characters. This allows the message to be easier to read on GitHub as well as in various git tools.
* The subject contains succinct description of the change:
* use the imperative, present tense: "change" not "changed" nor "changes"
* no dot (.) at the end
* Commit type:
* feat: a new feature
* fix: a bug fix
* refactor: a code change that neither fixes a bug nor adds a feature
* test: adding missing tests
* chore: changes to the build process or auxiliary tools and libraries such as documentation generation