Skip to content

Commit f2614c2

Browse files
committed
Update README
1 parent 3a7b9e3 commit f2614c2

File tree

2 files changed

+50
-1
lines changed

2 files changed

+50
-1
lines changed

README.md

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,50 @@
1-
# lotion
1+
<p align="center">
2+
<h1 align="center"><b>🧴 Lotion</b></h1>
3+
<p align="center">
4+
An open-source Notion UI built with Vue 3
5+
</p>
6+
7+
<p align="center">
8+
<img src="./assets/lotion.png" style="border-radius: 10px;" />
9+
<br />
10+
<br />
11+
<a href="https://twitter.com/dashibase">
12+
<img src="https://img.shields.io/badge/Twitter-00acee?logo=twitter&logoColor=white" />
13+
</a>
14+
<a href="https://discord.gg/CqgZGh4ZA8">
15+
<img src="https://img.shields.io/badge/Discord-5865F2?logo=discord&logoColor=white" />
16+
</a>
17+
<img src="https://img.shields.io/github/license/dashibase/dashibase-insert" />
18+
<br />
19+
</p>
20+
21+
## Features
22+
23+
- [x] Block-based editor
24+
- [x] Drag to reorder blocks
25+
- [x] Basic Markdown-parsing including bold, italic, headings and divider
26+
- [x] Type '/' for command menu and shortcuts
27+
28+
## Getting Started
29+
30+
**1. Clone this repository, go to the root directory and install packages**
31+
32+
```bash
33+
git clone https://github.com/dashibase/dashibase-insert
34+
cd dashibase-insert
35+
npm i
36+
```
37+
38+
**2. Run dev**
39+
40+
```bash
41+
npm run dev
42+
```
43+
44+
You should see what looks like the screenshot about.
45+
46+
**3. Contribute!**
47+
48+
Lotion is quite limited for now but we hope it serves as a good starting point for other folks looking to build their own editors.
49+
50+
We would love to make Lotion more extensible and welcome any suggestions or contributions!

assets/lotion.png

954 KB
Loading

0 commit comments

Comments
 (0)