ritext 1.0.28 → 1.0.29
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +65 -10
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,16 +1,71 @@
|
|
|
1
|
-
<
|
|
2
|
-
<
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
1
|
+
<p align="center">
|
|
2
|
+
<picture>
|
|
3
|
+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/siamahnaf/assets-kit/main/logo/logo-white.png">
|
|
4
|
+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/siamahnaf/assets-kit/main/logo/logo-black.png">
|
|
5
|
+
<img alt="Ritext" src="https://raw.githubusercontent.com/siamahnaf/assets-kit/main/logo/logo-black.png" width="240">
|
|
6
|
+
</picture>
|
|
7
|
+
</p>
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
Ritext
|
|
9
|
+
<p align="center">
|
|
10
|
+
<b>Ritext</b> — A modern, composable WYSIWYG rich text editor built with <b>Tailwind CSS</b>, powered by <b>Tiptap</b>.
|
|
11
|
+
<br />
|
|
12
|
+
Build your own toolbars & controls with clean React components — no heavy UI layer, no extra dependencies beyond Tiptap.
|
|
13
|
+
</p>
|
|
10
14
|
|
|
11
|
-
<
|
|
15
|
+
<p align="center">
|
|
16
|
+
<a href="https://www.npmjs.com/package/ritext"><img alt="npm" src="https://img.shields.io/npm/v/ritext?logo=npm"></a>
|
|
17
|
+
<a href="https://www.npmjs.com/package/ritext"><img alt="downloads" src="https://img.shields.io/npm/dm/ritext"></a>
|
|
18
|
+
</p>
|
|
19
|
+
|
|
20
|
+
<p align="center">
|
|
21
|
+
<a href="https://www.buymeacoffee.com/siamahnaf" target="_blank">
|
|
22
|
+
<img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" height="48">
|
|
23
|
+
</a>
|
|
24
|
+
</p>
|
|
25
|
+
|
|
26
|
+
---
|
|
27
|
+
|
|
28
|
+
## ✨ Why Ritext?
|
|
29
|
+
- **Composable UI**: bring your own toolbar/buttons/components
|
|
30
|
+
- **Tiptap-powered**: reliable ProseMirror foundation
|
|
31
|
+
- **Tailwind-friendly**: build modern UI fast
|
|
32
|
+
- **Package-first**: works great in Next.js apps & component libraries
|
|
33
|
+
|
|
34
|
+
---
|
|
35
|
+
|
|
36
|
+
## 📚 Docs help needed (Contributions welcome!)
|
|
37
|
+
Ritext is stable and production-ready — but the documentation is still growing.
|
|
38
|
+
|
|
39
|
+
If you like this project, please help by writing or improving docs:
|
|
40
|
+
- ✅ Installation & setup (Next.js / React)
|
|
41
|
+
- ✅ Basic editor example + toolbar patterns
|
|
42
|
+
- ✅ Extension usage & custom UI components
|
|
43
|
+
- ✅ Theming, styling, and Tailwind tips
|
|
44
|
+
- ✅ Recipes (tables, images, placeholders, slash menu, etc.)
|
|
45
|
+
|
|
46
|
+
### Good first contribution ideas
|
|
47
|
+
- Add a “Getting Started” page
|
|
48
|
+
- Document one extension (Bold/Italic/Table/Image/etc.)
|
|
49
|
+
- Add small code examples + screenshots/GIFs
|
|
50
|
+
|
|
51
|
+
**Want to contribute?**
|
|
52
|
+
1. Fork the repo
|
|
53
|
+
2. Create a new branch: `docs/<topic>`
|
|
54
|
+
3. Update or add docs inside `content/` (Markdown)
|
|
55
|
+
4. Open a PR ✨
|
|
56
|
+
|
|
57
|
+
> If you’re not sure what to write, open an issue and I’ll assign you a docs task.
|
|
58
|
+
|
|
59
|
+
---
|
|
60
|
+
|
|
61
|
+
## 🤝 Contributing
|
|
62
|
+
All contributions are welcome — issues, PRs, bug reports, improvements, and docs.
|
|
63
|
+
|
|
64
|
+
- Create an issue for bugs/feature requests
|
|
65
|
+
- PRs should include a clear description and screenshots if UI-related
|
|
66
|
+
|
|
67
|
+
---
|
|
12
68
|
|
|
13
|
-
### This is an testing phase will publish soon.
|
|
14
69
|
|
|
15
70
|
## Connect with me
|
|
16
71
|
<div style="display: flex; align-items: center; gap: 3px;">
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "ritext",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.29",
|
|
4
4
|
"description": "Ritext is a modern WYSIWYG rich text editor built with Tailwind CSS, powered by Tiptap. It offers a customizable UI and functional layer that lets you design your own editor controls and toolbars with clean, composable React components—no heavy UI, no extra dependencies beyond Tiptap.",
|
|
5
5
|
"homepage": "https://ritext.vercel.app/",
|
|
6
6
|
"main": "dist/index.js",
|