TidGi is an privatcy-in-mind, automated, auto-git-backup, freely-deployed Tiddlywiki knowledge management Desktop note app, with local REST API. 「 太记 」是一个基于「 太微 TiddlyWiki 」的知识管理桌面应用,能保护隐私内容、高级自动化、自动Git云备份、部署为博客,且可通过RESTAPI与Anki等应用连接。(迭代开发中欢迎试用,开发进度见下方链接)(Under active development, see website below for details)
Find a file
2021-04-24 20:57:41 +08:00
.github feat: better bug report 2021-04-17 22:28:28 +08:00
.vscode fix: type errors 2021-04-24 20:57:41 +08:00
build-resources feat: update app icon 2021-04-23 13:48:09 +08:00
docs/images chore: remove legacy doc site 2020-10-11 21:39:26 +08:00
features fix: execution too fast causes 'socket hang up' 2021-04-23 00:54:15 +08:00
localization fix: bad style of done button 2021-04-18 22:49:50 +08:00
src fix: type errors 2021-04-24 20:57:41 +08:00
template/wiki chore: upgrade deps 2021-01-12 00:50:27 +08:00
.editorconfig refactor: initial transform to ts 2020-12-19 22:33:59 +08:00
.env feat: add SKIP_PREFLIGHT_CHECK=true to skip silly react check 2020-08-22 19:36:24 +08:00
.eslintignore refactor: initial transform to ts 2020-12-19 22:33:59 +08:00
.eslintrc.js fix: type errors 2021-04-24 20:57:41 +08:00
.flowconfig Update .flowconfig 2020-10-17 12:21:44 +08:00
.gitignore feat: cleanup temp folder between tests 2021-04-19 01:45:46 +08:00
.prettierrc.js lint: fix linter config 2020-12-20 20:58:49 +08:00
cucumber.js chore: setup cucumber BBD environment 2021-04-18 21:47:05 +08:00
LICENSE Initial 2019-08-30 11:41:23 +07:00
package-lock.json fix: type errors 2021-04-24 19:42:47 +08:00
package.json fix: type errors 2021-04-24 19:42:47 +08:00
PrivacyPolicy.md feat: add logrocket 2021-02-27 23:46:23 +08:00
README.md doc: 把TIddlyWiki翻译成太微,TiddlyGit翻译成太记 2021-03-30 11:27:07 +08:00
tsconfig.eslint.json fix: type errors 2021-04-24 20:57:41 +08:00
tsconfig.json chore: setup cucumber BBD environment 2021-04-18 21:47:05 +08:00
webpack.alias.js fix: ts-import plugin 2021-03-12 01:06:22 +08:00
webpack.main.config.js fix: type errors 2021-04-24 19:42:47 +08:00
webpack.plugins.js chore: allow passing NodeEnv to the code 2021-04-18 21:44:34 +08:00
webpack.renderer.config.js fix: code splitting produce wrong code path 2021-03-21 17:55:09 +08:00
webpack.rules.js Update webpack.rules.js 2021-03-22 00:07:57 +08:00

TiddlyGit 太记 License: MPL 2.0

macOS Linux Windows
GitHub Actions macOS Build Status GitHub Actions Linux Build Status GitHub Actions Windows Build Status

TiddlyGit - Customizable personal knowledge-base with Github as unlimited storage and blogging platform.

注意,正在重构成 TS版本一段时间内不会更新新版会修复很多问题。refactor TS

Attention, It is in a process refactoring to ts, there won't be an update for a while. New version will fix various of things. refactor TS

GitHub Releases

For windows users (I'm personally using MacOS), I'm recently lacking time to fully test the Windows build, so there may be some bug in it, if you can help test and find some bug, please contact me github issue.

For mac users, since I haven't buy Apple developer key yet, so you have to entrust App to open it ◀

Click "Cancel" ↓

step00001

step00002

step00003

Click "Open" ↓

step00004

Click "OK" ↓

step00005

About TiddlyGit-Desktop 关于「太记-桌面版」

TiddlyGit is a cross-platform Note Taking & GTD & Fragment Knowledge Management desktop app powered by nodejs-TiddlyWiki, it ship with a lot of tiddlywiki plugins from the TiddlyWiki community.

「太记」是一个跨平台的笔记软件、时间和任务管理工具、碎片化知识管理工具,此乃其桌面版。「太记」基于强大的 NodeJS 版「太微TiddlyWiki 构建,并带上了大量来自太微社区TiddlyWiki community的插件。

You can call it TG-Note, it is totally free and you own all your data. Code by the people, build for the people.

「太记」来自 TiddlyWiki 的译名「太微」,以及 TiddlyGit 首字母的谐音。当然你也可以直接叫它 TGNote镰锤☭笔记。

为什么把 TiddlyWiki 翻译成「太微」?因为受到 @pimgeek 的启发TiddlyWiki 可以干很多细致轻量的工作但也从不限制用法可以无限组合叠加。故以其首字母音译为「太微」TiddlyWiki 可以称为「太微笔记」「太微万能抽屉」「太微卡片盒」……

太微垣,三垣之一,按《步天歌》,太微垣為三垣的上垣。 太微垣又名天庭,是政府的意思,也是貴族及大臣們居住的地方。

Screenshot of main-window Screenshot of add-workspace Screenshot of preference

Why Github?

Because Github is one of the best free civil level BaaS:

  1. Its storage is basically free, allow us to store unlimited images and pdf files, which can have permanent URIs for public download
  2. It has GraphQL API that allow us programmatically update our wiki
  3. It has free CI to automatically deploy our TiddlyWiki blog
  4. It provides unlimited repository, public and private, which enables us to store private content into our TiddlyWiki

Why not TiddlyDesktop?

Main reasons:

  1. NodeJS version of TiddlyWiki have seamless auto-save experience, which is taking the advantage of SyncAdaptor instead of Saver, TG have better support for NodeJS wiki
  2. Using NodeJS wiki, We can have separated tiddler files, which can be modified by hand, or by other programs (e.g. VSCode with VSCode-TW5-Syntax)
  3. Though TiddlyDesktop can load wiki folder generated by nodejs-TiddlyWiki, it can't backup that folder to the Github easily like TG does
  4. With the electron as a shell, I can use fs, git and many other nodejs things within TiddlyWiki, which greatly extend the hackability, which is the reason why I choose TiddlyWiki as my daily KM tool

Download

Just download it from Github Release Free Download

You can also find changelog in the Release.

Development

Development plan of TiddlyGit-Desktop is listed in these Kanban.

Explanation of our code can be found in the Wiki.

To contribute, fork this repo, then clone it and setup development environment
# First, clone the project:
git clone https://github.com/YOUR_ACCOUNT/TiddlyGit-Desktop.git
cd TiddlyGit-Desktop
# Or maybe you are just using Github Desktop
# or GitKraken to clone this repo,
# and open it in your favorite code editor and terminal app

# install the dependencies

npm i

# Run development mode
# You can see webpack error messages in http://localhost:9000/
npm start

# Build for production

npm run package

Publish

Add a tag like vx.x.x to a commit, and push it to the origin, Github will start building App for all three platforms.

After Github Action completed, you can open Releases to see the Draft release created by Github, add some comment and publish it.

Credits

The desktop app shell is based on https://github.com/atomery/singlebox and atomery/webcatalog, they provide lots of utils around website-generated-app, much powerful than generating app from website simply using Chrome. Also the independent developer @quanglam2807 behind these great tools helps me a lot when I develop TiddlyGit.

Current Icon is download from iconsdb under Creative Commons Attribution-NoDerivs 3.0 , if you are a designer, please feel free to contribute your ICON if you have a better idea.