mirror of
https://github.com/toeverything/AFFiNE.git
synced 2024-11-27 06:33:32 +03:00
Add affine manual
This commit is contained in:
parent
6992cfc4eb
commit
02a8fde6dd
55
README.md
55
README.md
@ -7,22 +7,61 @@
|
||||
</h1>
|
||||
|
||||
<p align="center">
|
||||
Planning, Sorting and Creating all Together.
|
||||
</p>
|
||||
<p align="center">
|
||||
Open-source, Privacy-First, and Free to use.
|
||||
Planning, Sorting and Creating all Together. Open-source, Privacy-First, and Free to use.
|
||||
</p>
|
||||
|
||||
|
||||
# AFFiNE
|
||||
|
||||
<div align="center">
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
|
||||
|
||||
[![All Contributors](https://img.shields.io/badge/all_contributors-11-orange.svg?style=flat-square)](#contributors-)
|
||||
|
||||
<!-- ALL-CONTRIBUTORS-BADGE:END -->
|
||||
</div>
|
||||
|
||||
<p align="center">
|
||||
<a href="http://affine.pro"><b>Website</b></a> •
|
||||
<a href="https://discord.com/invite/yz6tGVsf5p"><b>Discord</b></a> •
|
||||
<a href="https://twitter.com/AffineOfficial"><b>Twitter</b></a> •
|
||||
<a href="https://medium.com/@affineworkos"><b>Medium</b></a> •
|
||||
<a href="https://t.me/affineworkos"><b>Telegram</b></a>
|
||||
</p>
|
||||
|
||||
<p align="center"><img width="1920" alt="affine_screen" src="https://user-images.githubusercontent.com/79301703/182363099-48b479c3-dc26-4fc3-8f9b-45f9cf358f9a.png"><p/>
|
||||
|
||||
# Stay Up-to-Date
|
||||
![952cd7a5-70fe-48ab-b74f-23981d94d2c5](https://user-images.githubusercontent.com/79301703/182365526-df074c64-cee4-45f6-b8e0-b912f17332c6.gif)
|
||||
|
||||
# The Philosophy of Affine
|
||||
## Shape your page
|
||||
An always good-to-read, structured docs-form page is the best for your notes, but a boundless doodle surface is better for collaboration and creativity.
|
||||
We make the shift and reshape easy, so you can shape the docs your way.
|
||||
With affine, every page comes with 2 views, and you can access and edit fully functioned blocks at anywhere, in any form.
|
||||
![546163d6-4c39-4128-ae7f-55d59bc3b76b](https://user-images.githubusercontent.com/79301703/182365611-b0ba3690-21c0-4d9b-bfbc-0bc15da05aeb.gif)
|
||||
|
||||
## Plan your task
|
||||
We really appreciate the idea of monday, airtable and notion database. They inspired what we think is right for task management. But we don't like the repeated works -- we don't want to set a todo easily with markdown but end up re-write it again in kanban or other databases.
|
||||
With affine, every block group has infinite views, for you to keep your single source of truth.
|
||||
|
||||
## Sort your knowledge
|
||||
A good, semantic knowledge base is made of reusable, linked elements. Affine is completely made on top of the idea of blocks. Blocks can be 2-way linked, duplicated, reused and synced between docs.
|
||||
Rich-text paragraphs are blocks. Images are blocks. Todos are blocks and quotes are blocks. You can assemble blocks to form a bigger block, and you can even embed another as a block!
|
||||
As semantic web lovers, we don't like the idea of folders that much, and we make everything easy to find.
|
||||
|
||||
## Create your story
|
||||
We want your data always to be yours, and we don't want to make any sacrifice to your accessibility. Your data is always local-stored first, yet we support real-time collaboration on a peer-to-peer basis. We don't think "privacy-first" is a good excuse for not supporting modern web features.
|
||||
You may take and insert pics on your phone, then edit them on your desktop, and share them with your collaborators.
|
||||
Affine is fully built with web technologies so that consistency and accessibility are always guaranteed on Mac, Windows and Linux. The local file system support will be available when version 0.0.1beta is released.
|
||||
|
||||
User Installation
|
||||
Please view the documentation for OS specific installation instructions.
|
||||
|
||||
Built With
|
||||
- Typescript
|
||||
- Rust
|
||||
- React
|
||||
Getting Started with development
|
||||
Please view the documentation for OS specific development instructions
|
||||
|
||||
Workspace for AFFiNE
|
||||
|
||||
## Installation
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user