https://github.com/vincentdchan/CubyText

An open-source knowledge management app.
https://github.com/vincentdchan/CubyText

gui-application knowledge-graph local-first note-taking privacy privacy-first productivity

Last synced: about 2 months ago
JSON representation

An open-source knowledge management app.

• Host: GitHub
• URL: https://github.com/vincentdchan/CubyText
• Owner: vincentdchan
• License: mit
• Created: 2022-09-12T09:30:41.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-11T01:26:01.000Z (almost 2 years ago)
• Last Synced: 2024-06-03T10:44:32.114Z (4 months ago)
• Topics: gui-application, knowledge-graph, local-first, note-taking, privacy, privacy-first, productivity
• Language: TypeScript
• Homepage:
• Size: 4.57 MB
• Stars: 679
• Watchers: 12
• Forks: 25
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.txt

Awesome Lists containing this project

• my-awesome - vincentdchan/CubyText - application,knowledge-graph,local-first,note-taking,privacy,privacy-first,productivity pushed_at:2022-10 star:0.7k fork:0.0k An open-source knowledge management app. (TypeScript)

README

        
# Cuby Text

![](./images/home.png)

## What

Cuby Text is:

- An experimental knowledge management app

- An app focused on writing

- An open source app

- A personal project

Cuby Text is **NOT**:

- An open-source alternative to a commercial product

- A stable product

## Why

Many excellent knowledge management apps are based on extended markdown files.

They are powerful but not expressive.

New products use blocks to organize their content.

It's very inspirational. I like them, but I want privacy and native experiences too.

So I created CubyText. It's fast and designed to be extensible.

To achieve this goal I built the [blocky editor](https://github.com/vincentdchan/blocky-editor).

It doesn't have complex concepts, just simple pages and blocks. No big deal.

## Download

[Releases](https://github.com/vincentdchan/CubyText/releases)

## Features

- Simple and flexible

  ![](./images/concepts.png)

- Everything is a block

  

- Rich-text, with markdown shortcuts

  | Bold | Heading |

  | ---- | ------- |

  | ![](./images/bold-ani.gif) | ![](./images/intro-ani.gif) |

  - Press `[[` to create references

    

- Multiple tabs

  ![](./images/multiple-tabs.png)

- Auto outline/graph generation

- Cross platforms

  - MacOS

  - Windows

  - Linux

- Local first

  - All data are stored locally in one file, easy to transfer and backup

  - Fast loading and searching

    

- Dark mode

  ![](./images/dark-mode.png)

Work in progress:

- [ ] Extensions(WIP)

## Technologies

The primary third-party libraries and frameworks:

- **[Blocky editor](https://github.com/vincentdchan/blocky-editor)**

- **[Preact](https://preactjs.com/)**

- **[Force graph](https://github.com/vasturiano/force-graph)**

- **[SQLite](https://www.sqlite.org/index.html)**

- **[Electron](https://www.electronjs.org/)**

The principles:

- The dependencies should be as few as possible

- The tech stack should be easy to learn and contribute

## Contributing

[CONTRIBUTING](./CONTRIBUTING.md)

## FAQ

### How to sync data between devices?

**TLDR:** not support yet

This feature is intended to be implemented by the extension API.