# CubyText

**Repository Path**: iluvchang/CubyText

## Basic Information

- **Project Name**: CubyText
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-12-29
- **Last Updated**: 2023-12-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## 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

  <img src="./images/blocks.png" width="520" />

- Rich-text, with markdown shortcuts
  | Bold | Heading |
  | ---- | ------- |
  | ![](./images/bold-ani.gif) | ![](./images/intro-ani.gif) |

  - Press `[[` to create references

    <img src="./images/create-references.gif" width="320" />

- 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

    <img src="./images/search.gif" width="520" />

- 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.