There can be more than Notion and Miro. Affine is a next-gen knowledge base that brings planning, sorting and creating all together. Privacy first, open-source, customizable and ready to use.

Toeverything

Last update: Jan 9, 2023

Overview

AFFiNE.PRO
The Next-Gen Knowledge Base to Replace Notion & Miro.

Planning, Sorting and Creating all Together. Open-source, Privacy-First, and Free to use.

Website • Discord • Twitter • Medium • Telegram

Stay Up-to-Date and Support Us

How to use

If you have experience in front-end development, you may wish to refer to our documentation to learn more about deploying your own version or contributing further to development. For those intersting in trying our latest version, please bear with us as we are planning to launch a web version soon. Also, thanks to Lee who has made a desktop build with Tauri for you to try out. Please notice that AFFiNE is still under Alpha stage and is not ready for production use.

Stay Up-to-Date and Support Us
How to Use
Table of contents
Documentation
- Getting Started with development
Roadmap
Releases
Feature requests
FAQ
The Philosophy of AFFiNE
Community
Contributors
Acknowledgments
License

Shape your page

Plan your task

Sort your knowledge

Create your story

We want your data always to be yours, without any sacrifice to your accessibility. Your data is always stored local 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. And when it comes to collaboration, these features are not just necessarily for teams -- you can take and insert pictures on your phone, edit them from your desktop, and then share them with your collaborators. Affine is fully built with web technologies to ensure consistency and accessibility on Mac, Windows and Linux. The local file system support will be available when version 0.0.1beta is released.

Documentation

AFFiNE is not yet ready for production use. For installation, you may check how to build or deploy AFFiNE from our quick-start guide. Alternatively, you can view our full documentation.

Getting Started with development

Please view the path Contribute-to-AFFiNE/Software-Contributions/Quick-Start in the documentation.

Roadmap

Coming Soon...

Releases

Get our latest release notes from here.

Feature requests

Please go to feature requests.

FAQ

Get quick help on Telegram or Discord and join our community of developers and contributors.

Our latest news can be found on Twitter, Medium and the AFFiNE Blog.

The Philosophy of AFFiNE

Timothy Berners-Lee once taught us about the idea of the semantic web, where all the data can be interpreted in any form while the "truth" is kept. This gives our best image of an ideal knowledge base by far, that sorting of information, planning of project and goals as well as creating of knowledge can be all together. We have witnessed waves of paradigm shift so many times. At first, everything was noted on office-like apps or DSL like LaTeX, then we found todo-list apps and WYSIWYG markdown editors better for writing and planning. Finally, here comes Notion and Miro, who take advantage of the idea of blocks to further liberate our creativity. It is all perfect... without waste operations and redundant information. And, we insist that privacy first should always be given by default. That's why we are making AFFiNE. Some of the most important features are:

Transformable
- Every block can be transformed equally
  - e.g. you can create a todo in Markdown in the text view and then later edit it in the kanban view.
- Every document can be turned into a whiteboard
  - 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.
Atomic
- The basic elements of AFFiNE are blocks, not pages.
  - Blocks can be directly reused and synced between pages.
- Pages and blocks are searched and organized based on connected graphs, not tree-like paths.
- Dual-link and semantic search are fully supported.
Collaborative and privacy-first
- Data is always stored locally by default
- CRDTs are applied so that peer-to-peer collaboration is possible.

We appreciate the ideas of Monday, Airtable, and Notion databases. They have inspired us and shaped our product, helping us get it right when it comes to task management. But we also do things differently. We don't like doing things again and again. It's easy to set a todo with Markdown, but then why do you need to repeat and recreate data for a kanban or other databases. This is the power of AFFiNE. With AFFiNE, every block group has infinite views, for you to keep your single source of data, a signle source of truth.

We would like to give special thanks to the innovators and pioneers who greatly inspired us:

Quip & Notion -- that docs can be organized as blocks
Taskade & Monday -- brilliant multi-dimensional tables
Height & Linear -- beautiful task management tool

We would also like to give thanks to open-source projects that make affine possible:

Yjs & Yrs -- Fundamental support of CRDTs for our implementation on state management and data sync.
React -- View layer support and web GUI framework.
Rust -- High performance language that extends the ability and availability of our real-time backend, JWST.
Fossil -- Source code management tool made with CRDTs which inspired our design on block data structure.
slatejs -- Customizable rich-text editor.
Jotai -- Minimal state management tool for frontend.
Tldraw -- Excellent drawing board.
MUI -- Our most used graphic UI component library.
Other dependencies

Thanks a lot to the community for providing such powerful and simple libraries, so that we can focus more on the implementation of the product logic, and we hope that in the future our projects will also provide a more easy-to-use knowledge base for everyone.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

Discuss AFFiNE on GitHub

Contributors

_DarkSky 💻 📖	_{Chi Zhang} 💻 📖	_{wang xinglong} 💻 📖	_DiamondThree 💻 📖	_Whitewater 💻 📖	_{xiaodong zuo} 💻 📖	_{MingLIang Wang} 💻 📖
_Qi 💻 📖	_mitsuhatu 💻 📖	_Austaras 💻 📖	_{Jin Yao} 💻 📖

License

AFFiNE is distributed under the terms of MIT license.

See LICENSE for details.

Comments

[bug] Edgeless Mode drawings lost when adding a new group in Paper Mode

Describe the bug

Edit data in edgeless mode first, then edit data in paper mode; return to edgeless mode, the data previously edited in edgeless mode will be lost

To Reproduce

1.、Edit data in edgeless mode first, 2、then edit data in paper mode; 3、return to edgeless mode, the data previously edited in edgeless mode will be lost

Screenshots

No response

Expected behavior

No response

Platform

No response

Browser

No response

Additional context

No response
bug

opened by Avey777 16
[bug]: Browser APIs require a secure environment

Describe the bug

Edge browser cannot SYNC DATA TO DISK

To Reproduce

Open the demo prompts To begin saving changes you can SYNC DATA TO DISK with the latest version of Chromium based browser like Chrome/Edge

Screenshots

Expected behavior

No response

Platform

Windows 11

Browser

Microsoft Edge Version 104.0.1293.63 (Official build) (64-bit)

Additional context

No response
bug

opened by Jones-F 16
[bug]: Firefox Blank Page Bug

Describe the bug

Nothing displays when I open AFFiNE with firefox except a few buttons.

To Reproduce

Open the https://livedemo.affine.pro/AFFiNE/ in firefox.

Screenshots

Expected behavior

Nothing appears other than a few buttons. It's the same with self hosted instance. When I open the online version and the self hosted version in edge it works flawlessly.

Platform

Windows 10

Browser

Firefox

Additional context

No response
bug

opened by ChrisFarmer-dev 12
[improvement]: request for installation guide

1~3 main use cases of the proposed improvement

As a user, I don't know how to install and run this software

Ideas for solution

If it has very few dependencies, it is recommended to run it via docker or docker-compose

what types of users can benefit from using your proposed improvement

all users

Additional context

No response
improvement

opened by zheng1 8
Edgeless mode > Edit text mode on dblclick
Now in edgeless mode it is very difficult to edit text.

This PR helps below:-

Single Click allow to select text shape & ability to drag

On double click enter the edit text mode. Now much better experience.

Default ondblclick event is not triggering due to TLDraw hijacking the pointer events. That's why used a dbl click detection logic.
opened by Proful 7
[bug]: Quick Search Style
Describe the bug

Wrong ctrl + K style for search

To Reproduce

https://pathfinder.affine.pro/

Ctrl + K

Screenshots

Expected behavior

No response

Platform

Window11

Browser

Chrome

Additional context

No response
bug alpha triaging
opened by Agility6 6
Login failed

Describe the bug

Login failed

To Reproduce

I learned to install affine on this website. https://mariushosting.com/how-to-install-affine-on-your-synology-nas/

After the installation is completed, click login and an error will be prompted.

I thought it was my personal problem, but it seems that other people have also encountered it.

Screenshots

Expected behavior

No response

Platform

Synology dsm7.1

Browser

chrome

Additional context

No response
bug

opened by i-iooi-i 6
feat: PWA support

Will close #257

https://user-images.githubusercontent.com/5123601/197326132-e4ce040f-0a1c-471d-aabf-3ddf314e20f4.mp4

NOTES If you like to test it with pnpm start locally, please git checkout to 1cabbf9cc6a895f3319e5b8533ac77e7df9c88c8.

opened by pingren 5
[feature]: docker support raspberry pi

1~3 main use cases of the proposed feature

dockerfile support armv8?

Ideas for solution

No response

what types of users can benefit from using your proposed feature

No response

Additional context

No response
enhancement

opened by May-Yaha 5
[bug]: The code block behavior is not correct
Describe the bug

No response

To Reproduce

input / , and input code

click the button code

you will find the page create a new code block below, and the text you input to filter the block type is not replaced

Screenshots

Expected behavior

No response

Platform

MacOS 13 Beta6

Browser

Chrome 104.0.5112.101

Additional context

No response
bug
opened by Zheaoli 5
[feature]: Roadmap issue before beta
We have added the following issues to the roadmap. Our roadmap will release in these days.

Multi language

[x] Multi language support: https://github.com/toeverything/AFFiNE/issues/242

[x] Maybe new language support can be added: https://github.com/toeverything/AFFiNE/issues/151

[x] Support Chinese: https://github.com/toeverything/AFFiNE/issues/327

Support docker or self host

[ ] Persisted data and dedicated users with OpenID Connect support: https://github.com/toeverything/AFFiNE/issues/244

[x] Adds support for Docker: https://github.com/toeverything/AFFiNE/issues/235

[x] How to configure docker to map data outside of docker: https://github.com/toeverything/AFFiNE/issues/209

[x] Add arm64 Support to the Docker Images: https://github.com/toeverything/AFFiNE/issues/185

Support table

[x] Support basic table: https://github.com/toeverything/AFFiNE/issues/213

Optimize build

[x] Slow build speed: https://github.com/toeverything/AFFiNE/issues/203

Support PWA

[x] Add PWA function: https://github.com/toeverything/AFFiNE/issues/257

Support mobile or browser compatibility

[ ] Mobile browser support: https://github.com/toeverything/AFFiNE/issues/251

[ ] Browser compatibility issues in Chrome and Safari: https://github.com/toeverything/AFFiNE/issues/87

Support file export

[ ] Support for exporting files e.g. pdf, doc: https://github.com/toeverything/AFFiNE/issues/246

Support mathematical formula

[ ] Extended input support - mathematical support (Mathjax, KaTeX, server-side LaTeX renderer, Mathlive, etc. ): https://github.com/toeverything/AFFiNE/issues/170

Reading mode

[ ] Content still editable in reading mode: https://github.com/toeverything/AFFiNE/issues/72

Support Mindmap

[ ] https://github.com/orgs/toeverything/projects/4/views/18
opened by alt1o 5
[bug]: all page's section is not responsive (feedback by Abid)
Describe the bug

All page's section is not responsive happening when make my windows portrait mode or side by side with another window

To Reproduce

Go to pathfinder.affine.pro

when I make my windows portrait mode or side by side with another window

all page's action is not responded

Screenshots

Expected behavior

All actions should be responded as expected. currently it shown as: video for window bug.webm

Platform

Linux

Browser

No response

Additional context

Feedback by https://github.com/enamulhasanabid
bug alpha
opened by Yipei-Operation 1
[Question] Having issue load the official site.

Hi everyone, I have met this issue currently using latest Chrome Browser. There is no warning or error in the console. I suppose the screenshot can illustrate the problem. It would be best if this issue be helpful for someone to solve the problem.
reproduction needed

opened by Lantianyou 5
[bug]: `Ctrl/⌘ + ?` should be replaced with `Ctrl/⌘ + K`

1~3 main use cases of the proposed improvement

As a person who is using a German keyboard, I cannot type the shortcut CTRL+?. The ? key does not exist on the German keyboard, and is a shortcut by itself (SHIFT+ß).

Ideas for solution

I propose to change the shortcut to something else. GitHub for example uses CTRL+K and CTRL+ALT+K inside text boxes to work around the conflict with creating a link.

what types of users can benefit from using your proposed improvement

users that use a non-english keyboard layout

Additional context

CTRL+K and CTRL+ALT+K are commonly used to search for other pages, and to open quick search menus.
bug

opened by MarvinJWendt 5
[improvement]: support shortcuts "Command + Backspace" to remove paragraphs consecutively

1~3 main use cases of the proposed improvement

When I need to selectively delete paragraphs (e.g. several consecutive items in a list), I usually use the "Command + Backspace" shortcut, which allows me to easily delete consecutive paragraphs by holding down Command while clicking Backspace a few times. Affine can not consecutively remove paragraphs by this way.

https://user-images.githubusercontent.com/36295999/210746439-386f1300-1d7c-4e71-ad65-4f2c54bb83fe.mov

Ideas for solution

No response

what types of users can benefit from using your proposed improvement

No response

Additional context

No response
improvement

opened by chenmoonmo 0
[improvement]: Expect the title of the page to be modified after the page is switched

1~3 main use cases of the proposed improvement

Expect the title of the page to be modified after the page is switched, for example, if you visit a page, the title of the page is displayed, if you switch to the list page, the list page is displayed

Ideas for solution

No response

what types of users can benefit from using your proposed improvement

No response

Additional context

No response
improvement alpha

opened by tzhangchi 0

Releases(v0.0.1-alpha-Abbey-Wood)

v0.0.1-alpha-Abbey-Wood(Jan 7, 2023)
Document management (create / favorite / delete / trash) @QiShaoXuan

Upgrade blocksuite v0.3.0 @doodlewind

Simple quick search @JimmFly

Divider block @JimmFly

Embed image block @DiamondThree

Inline popover menu (quick bar) @lawvs

Code block @thorseraq

Shape block @Himself65

Exception Page @SaikaSakura @DiamondThree

E2E Testing CI @QiShaoXuan @tzhangchi

Changelog Bot CI @DiamondThree

Basic PWA @chenmoonmo

Basic i18n integrate @JimmFly

New data center / page controller @darkskygit

Source code(tar.gz)
Source code(zip)
v0.0.1-alpha.0.4.1(Aug 12, 2022)
Thank you very much for your interest in AFFiNE! Some new and exciting changes are as follows:

Bug Fixes In our continued effort to make AFFiNE the most reliable all-in-one knowledge base, fixing bugs is always our main concern. Here's our work over the last few days:

Fixed: Text was obscured by inline menu in paper mode;

Fixed: Props format with errors and were showing in the console;

Fixed: When the user presses the shift key to draw consecutive straight lines, the starting point of the second line now coincides with the ending point of the first line;

Fixed: Tag-app caused page crashes during use;

Fixed: The page view did not accurately recognize the mouse selection;

Fixed: After switching pages, the behavior of selection feature did not meet expectations;

Fixed: AFFiNE was prompting a window during the installation process indicating that the installation has failed;

Fixed: Alignment of page styles with design drawings;

Fixed: In paper mode, no background colors could be added to the text;

Fixed: The GitBook URL now uses AFFiNE's domain name;

Fixed: The GitHub ReadMe badge has been updated;

Fixed: Low priority console warnings where React does not recognize isDisabled. AFFiNE is currently in the early alpha stage with limited access, and public early access will be available in the autumn of 2022.

AFFiNE is an open-source project which can be viewed on Github: https://github.com/toeverything/AFFiNE#readme

The official website for AFFiNE is https://affine.pro/

If you endorse this open source project, please help us by clicking the GitHub star, which is crucial for the future development of AFFiNE.

AFFiNE is very grateful to all open source contributors and will work to build a more positive open source ecosystem.

We welcome every user to offer feedback and suggestions. Please feel free to contact us on:

Reddit: https://www.reddit.com/r/Affine/

Discord: https://discord.gg/Arn7TqJBvG

Telegram: https://t.me/affineworkos

Twitter: https://twitter.com/AffineOfficial

Medium：https://medium.com/@affineworkos

Hope you have a nice time with AFFiNE!
Source code(tar.gz)
Source code(zip)
v0.0.1-alpha.0.3.4(Aug 5, 2022)
Thank you very much for your attention to AFFiNE! Some exciting changes in AFFiNE are as follows:

Bug Fixes

In our continued effort to make AFFiNE the most reliable workOS platform, fixing bugs is always our main concern. Here's our work in the last few days:

Fixed: In Kanban view, dragging a card with the mouse will trigger a selection and bring up a tag edit box;

Fixed: Adding a child of a page in page-tree in doc mode will throw an error in the page;

Fixed: User changes in the Kanban view are not synchronized when converting to text;

Fixed: When you add a tag to a block in an article and then hover over another block to add a tag, the tag edit card displays the tag record;

Fixed: In page mode, the block group toolbar and the mode switch button on the page are blocked from each other;

Fixed: In the board mode, when dragging one of the block groups into another block group, the first displayed indicator line will always be there;

Fixed: The 'ctrl + A' shortcut cannot be used in the input box of the edit panel of the tag app (Note: 'ctrl+a' key combination is a select-all shortcut).

AFFiNE is currently in the early alpha stage with limited access, and public early access will be available in the autumn of 2022.

AFFiNE is an open-source project which can be viewed on Github: https://github.com/toeverything/AFFiNE#readme

If you endorse this open source project, please help us by clicking the GitHub star, which is crucial for the future development of AFFiNE.

AFFiNE is very grateful to all open source contributors and will work to build a more positive open source ecosystem.

We welcome every user to offer feedback and suggestions. Please feel free to contact us on:

Reddit: https://www.reddit.com/r/Affine/

Discord: https://discord.gg/yz6tGVsf5p

Telegram: https://t.me/affineworkos

Twitter: https://twitter.com/AffineOfficial

Medium：https://medium.com/@affineworkos

Hope you have a nice time with AFFiNE !
Source code(tar.gz)
Source code(zip)