shalldie/tnote

Cloud Notebook in terminal. 终端中运行的云笔记本。

English | 中文

Cloud Notebook in terminal, based on Gist. 🦋

终端中运行的云笔记本，基于 Gist 构建。

tnote is a notebook application running on Terminal, allowing you to quickly access, synchronize content, and record your idea on different devices.

• Application 🎯
  • Shortcut keys, mouse operations
  • Cloud storage persistence, support Github/Gitee
  • i18n
• Files
  • Add, delete, check, and modify
• Detail 📝
  • Markdown highlighted
  • Edit and save
• Installation
  • binary
  • go install
  • docker

Prepare & Config

The application is built on gist, support Github/Gitee.

• Applying for Github access token, and then add it to the environment variable TNOTE_GIST_TOKEN。
• Applying for Gitee access token, and then add it to the environment variable TNOTE_GIST_TOKEN_GITEE。

# ~/.bashrc, github
export TNOTE_GIST_TOKEN="<your_access_token>"

Environment Variable	Default	Description
TNOTE_GIST_TOKEN / TNOTE_GIST_TOKEN_GITEE		access token applied for
TNOTE_LANG / LANG	en_US	Language preferred, optional values: en_US、zh_CN

Installation

1. binary

Download, download and execute it, adding to PATH would be even better.

File	OS
tnote.darwin-amd64	Mac amd64、Mac arm64
tnote.linux-amd64	Linux amd64
tnote.linux-arm64	Linux arm64

example:

# install
wget -O tnote [url]
sudo chmod a+x tnote
sudo mv tnote /usr/local/bin/tnote
# run
tnote

2. go install

Need [email protected]+ environment.

# install
go install github.com/shalldie/tnote@latest
# run
tnote

3. docker

docker run -it -e TNOTE_GIST_TOKEN=$TNOTE_GIST_TOKEN shalldie/tnote:latest

LICENSE

MIT

tnote's Issues

images

放一些readme用到的图片

「feature-request」添加国际化支持

背景

纯中文受众太小，想让这个工具能面向更多的用户。
计划添加多语言包支持。
The pure Chinese audience is too small, and I want this tool to be aimed at more users.
Plan to add support for multiple language packs.

目标

工具添加多语言包支持

计划

设置：环境变量 TNOTE_LANG =》 环境变量 LANG =》英文兜底
方案：调研国际化方案，目前计划自己简单封装

「feature-request」添加鼠标支持

引入 bubblezone，让鼠标也可以进行操作。

「bug」列表状态更新问题

1. 初始化过程中进行操作，会报错、数据异常
2. 删除、新建文件，右侧内容不更新
3. loading 调整

「feature-request」添加 gitee 支持

如题，添加gitee支持，国内用户会快一些

「Improvement」- 优化视图渲染

问题

视图闪烁

场景

1. 设备刷新率较低
2. markdown 内容太多

描述

目前的视图是全量渲染，在刷新率较低的设备，或者markdown内容太多时，滚动起来会造成闪烁问题。

计划

会探索、优化视图渲染方式，尝试局部刷新。

相关

charmbracelet/bubbletea#32
charmbracelet/bubbletea#95