chore: move client folders (#948)

This commit is contained in:
DarkSky
2023-02-10 20:41:01 +08:00
committed by GitHub
parent cb118149f3
commit 8a7393a961
235 changed files with 114 additions and 215 deletions

View File

@@ -0,0 +1,25 @@
# AFFiNE Docs
This repo is the source for AFFiNE documentation.
The published documentation is at:
- https://docs.affine.pro
Please [file an issue](https://github.com/toeverything/AFFiNE-docs/issues) if you can't find what you are looking for.
## Get Started
This repo is split into folders - with each folder being a seperate category of documentation.
You can browse the folders to view the pages within each category.
Please note: Some pages may not display correctly on GitHub, be sure to check the corresponding page on GitBook.
### Asset Naming
All assets should be stored in `.gitbook/assets/`.
The asset should be named according to where it will be used.
If an image is needed for `/developer-docs/coding/setup.md` the expected filename would be `developer-docs_coding_setup` where `_` seperates each folder/file. And if multiple images are required a unique filename can be appeneded, such as `_01`.

View File

@@ -0,0 +1,64 @@
We've been working hard on improving the user experience and have made several new features live for you to use.
If you are looking for **support**, would like to **suggest** your ideas, and keep on top of all the **latest updates**. We suggest you visit the [AFFiNE Community](https://community.affine.pro/home) site.
Let us know what you think of this latest version.
**AFFiNE Alpha brings:**
1. A much smoother editing experience, with much greater stability;
2. More complete Markdown support and improved keyboard shortcuts;
3. New features such as dark mode; Switch between view styles using the ☀ and 🌙.
4. Clean and modern UI/UX design.
5. You can self-host locally with Docker.
```basic
docker run -it --name affine -d -v [YOUR_PATH]:/app/data -p 3000:3000 ghcr.io/toeverything/affine-self-hosted:alpha-abbey-wood
```
**Looking for Markdown syntax or keyboard shortcuts?**
- Find the (?) in the bottom right, then the ️⌨️, to view a full list of Keyboard Shortcuts
### In this release, you can now:
- Manage your pages from the collapsible **sidebar**, which allows you to add **favorites** and restore deleted files from the **trash**
- Search through all your content with the quick search - activate with `Ctrl/⌘ + K`
- A friendly Reminder:
- In the case of unselected text, `Ctrl/⌘ + K` activates quick search;
- In the case of selected text, `Ctrl/⌘ + K` will firstly ask to add a hyperlink, and then using `Ctrl/⌘ + K` again activates the quick search
- Quickly format text with the **pop-up toolbar** (highlight any text to give it a try)
- Copy and paste **images** into your pages, resize them and add captions
- Add horizontal line dividers to your text with `---` and `***`
- Changes are saved **locally**, but we still recommend you export your data to avoid data loss
- Insert code blocks with syntax highlighting support using `````
### Playground:
[] Try a horizontal line: `---`
[] What about a code block? `````
```JavaScript
console.log('Hello world');
```
[] Can you resize this image?
![](https://cdn.affine.pro/694fdbab78e0da3ed7922eba7d506dcf12f57308e1904dd694f53eb2.jpg)
**How about page management?**
[] Create a new page
[] Send a page to trash
[] Favorite a page
**Have an enjoyable editing experience !!!** 😃
Have some feedback or just want to get in touch? Use the (?), then 🎧 to get in touch and join our communities.
**Interested in AFFiNE cloud?**
Head over to [general](https://community.affine.pro/c/general-discussion/) in our community and post what interests you about AFFiNE!

View File

@@ -0,0 +1,24 @@
We've been working hard on improving the user experience and have made several new features live for you to use.
If you are looking for **support**, would like to **suggest** your ideas, and keep on top of all the **latest updates**. We suggest you visit the [AFFiNE Community](https://community.affine.pro/home) site.
Let us know what you think of this latest version.
**AFFiNE Alpha Downhills brings:**
We are mainly working on features for pathfinder.
- [feat] SlashMenu #629
- [feat] BlockHub + DragHandle #630
- [feat] edgeless with basic usability #631
- [feat] bracket autocomplete #632 @lawvs
- [feat] database #633
- [feat] login with Google #608 @alt1o @darkskygit
- [feat] collaboration by AFFiNE Cloud #609 @darkskygit @zuoxiaodong0815
- [feat] local first multi workspace #610 @QiShaoXuan @darkskygit
- [feat] AFFiNE Cloud sync #611 @alt1o @SaikaSakura @darkskygit
- [feat] download workspace by AFFiNE Cloud #612 @darkskygit @alt1o @SaikaSakura
- [feat] workspace sharing with AFFiNE Cloud #613 @alt1o @SaikaSakura
- [feat] import markdown #615 @QiShaoXuan @thorseraq
- [feat] i18n integration #567 @JimmFly
- [feat] implement cloud provider for DataCenter @SaikaSakura @alt1o #708

View File

@@ -0,0 +1,59 @@
The AFFiNE Alpha is here! You can also view our [Official Website](https://affine.pro/)!
**What's different in AFFiNE Alpha?**
1. A much ~smoother editing~ experience, with much ~greater stability~;
2. More complete ~Markdown~ support and improved ~keyboard shortcuts~;
3. New features such as ~dark mode~;
- **Switch between view styles using the** ☀ **and** 🌙.
4. ~Clean and modern UI/UX~ design.
**Looking for Markdown syntax or keyboard shortcuts?**
- Find the (?) in the bottom right, then the ️⌨️, to view a full list of `Keyboard Shortcuts`
**Have an enjoyable editing experience !!!** 😃
Have some feedback or just want to get in touch? Use the (?), then 🎧 to get in touch and join our communities.
**Still in development**
There are also some things you should consider about this AFFiNE Alpha including some ~limitations~:
- Single page editing - currently editing multiple docs/pages is not supported;
- Changes are not automatically stored, to save changes you should export your data. Options can be found by going to the top right and finding the `⋮` icon;
- Without an import/open feature you are still able to access your data by copying it back in.
**Keyboard Shortcuts:**
1. Undo: `⌘+Z` or `Ctrl+Z`
2. Redo: `⌘+⇧+Z` or `Ctrl+Shift+Z`
3. Bold: `⌘+B` or `Ctrl+B`
4. Italic: `⌘+I` or `Ctrl+I`
5. Underline: `⌘+U` or `Ctrl+U`
6. Strikethrough: `⌘+⇧+S` or `Ctrl+Shift+S`
7. Inline code: `⌘+E` or `Ctrl+E`
8. Link: `⌘+K` or `Ctrl+K`
9. Body text: `⌘+⌥+0` or `Ctrl+Shift+0`
10. Heading 1: `⌘+⌥+1` or `Ctrl+Shift+1`
11. Heading 2: `⌘+⌥+2` or `Ctrl+Shift+2`
12. Heading 3: `⌘+⌥+3` or `Ctrl+Shift+3`
13. Heading 4: `⌘+⌥+4` or `Ctrl+Shift+4`
14. Heading 5: `⌘+⌥+5` or `Ctrl+Shift+5`
15. Heading 6: `⌘+⌥+6` or `Ctrl+Shift+6`
16. Increase indent: `Tab`
17. Reduce indent: `⇧+Tab` or `Shift+Tab`
**Markdown Syntax:**
1. Bold: `**text**`
2. Italic: `*text*`
3. Underline: `~text~`
4. Strikethrough: `~~text~~`
5. Inline code: `` `text` ``
6. Heading 1: `# text`
7. Heading 2: `## text`
8. Heading 3: `### text`
9. Heading 4: `#### text`
10. Heading 5: `##### text`
11. Heading 6: `###### text`