Skip to content

Commit e9eb0d7

Browse files
committed
feat: README
1 parent b53bcb5 commit e9eb0d7

File tree

4 files changed

+85
-4
lines changed

4 files changed

+85
-4
lines changed

README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,39 @@
11
# textflow
2+
3+
> WYSIWYG Editor [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=dineug.textflow-editor-vscode)
4+
5+
![erd-editor](https://github.com/dineug/textflow/blob/main/static/img/textflow-vscode.png?raw=true)
6+
7+
## Usage
8+
9+
create an empty file with a `.txf.json` extension and open it in Visual Studio Code.
10+
11+
## Features
12+
13+
### WYSIWYG Editor
14+
15+
- A rich-text editor based on Lexical.
16+
- To access commands, press the `/` key.
17+
18+
![command](https://github.com/dineug/textflow/blob/main/static/img/demo-command.webp?raw=true)
19+
20+
### Reference Linking
21+
22+
- Supports linking between documents.
23+
- To create a link, press the `[` key.
24+
25+
![reference](https://github.com/dineug/textflow/blob/main/static/img/demo-reference.webp?raw=true)
26+
27+
### Emoji Autocomplete
28+
29+
- Provides emoji autocompletion.
30+
- To search for an emoji, type `:` followed by a keyword.
31+
32+
![emoji](https://github.com/dineug/textflow/blob/main/static/img/demo-emoji.webp?raw=true)
33+
34+
### Theme Configuration
35+
36+
- Easily change themes using keyboard shortcuts.
37+
- Press `Ctrl + K` (Windows/Linux) or `⌘ + K` (Mac) to open the theme selector.
38+
39+
![theme](https://github.com/dineug/textflow/blob/main/static/img/demo-theme.webp?raw=true)

packages/editor/README.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

packages/vscode-extension/README.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# textflow
2+
3+
> WYSIWYG Editor [VSCode Extension](https://marketplace.visualstudio.com/items?itemName=dineug.textflow-editor-vscode)
4+
5+
![erd-editor](https://github.com/dineug/textflow/blob/main/static/img/textflow-vscode.png?raw=true)
6+
7+
## Usage
8+
9+
create an empty file with a `.txf.json` extension and open it in Visual Studio Code.
10+
11+
## Features
12+
13+
### WYSIWYG Editor
14+
15+
- A rich-text editor based on Lexical.
16+
- To access commands, press the `/` key.
17+
18+
![command](https://github.com/dineug/textflow/blob/main/static/img/demo-command.webp?raw=true)
19+
20+
### Reference Linking
21+
22+
- Supports linking between documents.
23+
- To create a link, press the `[` key.
24+
25+
![reference](https://github.com/dineug/textflow/blob/main/static/img/demo-reference.webp?raw=true)
26+
27+
### Emoji Autocomplete
28+
29+
- Provides emoji autocompletion.
30+
- To search for an emoji, type `:` followed by a keyword.
31+
32+
![emoji](https://github.com/dineug/textflow/blob/main/static/img/demo-emoji.webp?raw=true)
33+
34+
### Theme Configuration
35+
36+
- Easily change themes using keyboard shortcuts.
37+
- Press `Ctrl + K` (Windows/Linux) or `⌘ + K` (Mac) to open the theme selector.
38+
39+
![theme](https://github.com/dineug/textflow/blob/main/static/img/demo-theme.webp?raw=true)

packages/vscode-extension/package.json

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,16 +2,21 @@
22
"name": "textflow-editor-vscode",
33
"version": "0.1.0",
44
"private": true,
5-
"description": "textflow Editor VSCode Extension",
5+
"description": "WYSIWYG Editor VSCode Extension",
66
"displayName": "textflow",
77
"publisher": "dineug",
88
"categories": [
99
"Other",
10-
"Visualization"
10+
"Visualization",
11+
"Notebooks"
1112
],
1213
"keywords": [
1314
"textflow",
14-
"editor"
15+
"editor",
16+
"wysiwyg",
17+
"doc",
18+
"rich-text",
19+
"lexical"
1520
],
1621
"repository": {
1722
"type": "git",

0 commit comments

Comments
 (0)