https://github.com/multinite/multiui-rich-text-editor
A rich text editor for MultiUI built on top of TipTap.
https://github.com/multinite/multiui-rich-text-editor
Last synced: 3 months ago
JSON representation
A rich text editor for MultiUI built on top of TipTap.
- Host: GitHub
- URL: https://github.com/multinite/multiui-rich-text-editor
- Owner: Multinite
- License: mit
- Created: 2024-08-01T07:48:31.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-17T17:50:51.000Z (8 months ago)
- Last Synced: 2024-09-17T22:10:28.186Z (8 months ago)
- Language: JavaScript
- Size: 62.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# MultiUI Component Template
This is an official starter template for creating a component for MultiUI.
## What's inside
This project is a monorepo that contains Next.js, Vue, Svelte and Angular apps.
In a sense, you create components in the `packages` directory and then use them in the `apps` directory.
## How do I get started?
We recommend you read our documentation on creating a component for MultiUI:
https://multiui.org/docs/components/create-component
To get started, create your first component, then run the following command:
```sh
npm run dev
```
This will start a development server using [Turborepo](https://turbo.build/repo).
There should be 5 instances running:
- Next.js App
- Vue App
- Svelte App
- Angular App
- TypeScript dev server watching your component!
## Buidling, testing and linting
We use [turbo](https://turbo.build/repo) to manage our monorepo.
test your component, run the following command:
```sh
npm run test
```
build your component, run the following command:
```sh
npm run build
```
lint your component, run the following command:
```sh
npm run lint
```
## Publishing
To publish your component, we recommend you read our documentation on publishing a component for MultiUI:
https://multiui.org/docs/components/publish-component