mirror of
https://github.com/tiddly-gittly/TidGi-Desktop.git
synced 2026-01-22 04:21:03 -08:00
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)
ankielectronevernoteknowledge-graphknowledge-managementlinuxmacosnote-takingnotebooknotes-appnotionobsidianpkmtiddlywikitiddlywiki5windows
7edb132d32
* fix: missing return
* feat: showApiKey
* feat: undo commit
* feat: amend commit
* fix: file name quoted in git log
* fix: wikiWorkspaceDefaultValues
* fix: no ai commit message sometimes
* Persist only non-default preferences to storage
Added a utility to store only preferences that differ from defaults, reducing storage size and improving config readability. Updated the setPreferences method to use this utility before saving preferences.
* fix: External Attachment Handling in fs plugin instead of ext-attachment-plugin to handle direct tag update case which won't trigger th-saving-tiddler hook
* feat: api for plugin to create base64 file
* Show all untracked files and recreate Git history window
Updated git status commands to use '-uall' for displaying all untracked files, not just directories. Modified windowService.open calls for Git history to include the { recreate: true } option, ensuring the window is refreshed when opened from various menus.
* fix: handling of external attachments with _canonical_uri
Ensure tiddlers with _canonical_uri are always saved as .tid files, not as binary files, by forcing the .tid extension in FileSystemAdaptor. Update tests to verify this behavior. Also, skip loading files from the external attachments folder in loadWikiTiddlersWithSubWikis to prevent them from being loaded as separate tiddlers.
* Refactor external attachment utilities to module exports
Refactored externalAttachmentUtilities to use ES module exports instead of attaching functions to $tw.utils. Updated imports and mocks accordingly, removed related type definitions from ExtendedUtilities, and cleaned up obsolete meta file.
* disable enableFileSystemWatch to prevent bug for innocent users
* fix: test that requires enableFileSystemWatch use new step set to true
* Fix extension filter usage and sync workspace state after save
Refactored variable naming for extension filters in FileSystemAdaptor to improve clarity and fixed their usage in generateTiddlerFileInfo calls. Removed an unused import in routingUtilities.type.ts. Added a useEffect in useForm to sync workspace state with originalWorkspace after save, ensuring the save button disappears as expected.
* fix: review
* lint
* feat: unify AI commit entry points and add availability check - Unified all AI commit message generation to use syncService.syncWikiIfNeeded() for consistent business logic handling - Added externalAPI.isAIAvailable() method to check if AI provider and model are properly configured - Updated gitService.isAIGenerateBackupTitleEnabled() to use the new availability check - Removed redundant logging code since generateFromAI() automatically logs to database when externalAPIDebug is enabled - Simplified menu item creation logic in menuItems.ts - Ensured AI menu options only appear when both API credentials and free model are configured - Updated documentation to reflect the unified architecture
* Improve AI commit message diff filtering and API checks
Renamed the AI commit message entry points doc for clarity. Enhanced the AI availability check to better handle provider API key requirements, including support for providers that do not require keys. Improved plugin diff filtering to retain small config file diffs while omitting large plugin file contents, optimizing AI token usage.
* Update wiki
* Refactor and enhance Tidgi mini window initialization and sync
Refactors Tidgi mini window startup to use a new initializeTidgiMiniWindow method, improving workspace selection logic and view management. Adds concurrency locks to prevent race conditions during open/close operations. Enhances workspace sync/fixed mode handling, view cleanup, and error logging. Updates interfaces and utilities to support new behaviors and improves robustness of tray icon creation and view realignment.
* Refactor file system sync to use $tw.syncer.syncFromServer()
Introduces FileSystemWatcher to monitor file changes and collect updates for the syncer, replacing direct wiki updates in WatchFileSystemAdaptor. Updates documentation to describe the new syncer-driven architecture, echo prevention, and event handling. WatchFileSystemAdaptor now delegates file change detection and lazy loading to FileSystemWatcher, improving batch change handling and eliminating echo loops.
* Improve logging and cleanup in file system watcher and git ops
Added detailed logging to WatchFileSystemAdaptor and FileSystemWatcher for better traceability during initialization and test stabilization. Introduced a constant for the temporary git index prefix in gitOperations. Removed the unused comparison.ts utility for tiddler comparison. Enhanced comments and logging for AI commit message generation context.
* Improve GitLog i18n test and config refresh logic
Updated gitLog.feature to use only Chinese selectors for actions, revert, and discard buttons, improving i18n test reliability. In FileSystemWatcher, re-fetch workspace config before checking enableFileSystemWatch to ensure latest settings are respected. In useGitLogData, prevent file-change events from overriding commit/undo events to maintain correct auto-selection behavior.
* Improve Git log selection and test stability
Refines auto-selection logic in the Git log window to better handle uncommitted changes, commits, reverts, and undos. Updates the feature test to explicitly verify selection and UI state after each operation, improving reliability. Removes unnecessary config re-fetch in FileSystemWatcher and enhances logging for more accurate DOM update detection.
* Implement workspace config sync via tidgi.config.json
Adds support for syncing workspace configuration to tidgi.config.json in the wiki folder, enabling settings persistence and migration across devices. Introduces new documentation, feature tests, and supporting utilities for config file reading, writing, migration, and validation. Updates step definitions and test helpers to support config sync scenarios, and refactors database config utilities for modularity.
* Improve workspace config handling and sync logic
Enhances workspace lookup in step definitions to check both settings.json and tidgi.config.json, ensuring properties are found even if moved. Updates tidgiConfig write logic to remove the config file if all values are default. Refactors workspace save logic to always write syncable config to tidgi.config.json for all wiki workspaces before removing those fields from settings.json, preventing config loss.
* Update .gitignore
* Update wiki.ts
* Add delay before waiting for git log render after revert
- Add 1 second wait after clearing git-log-data-rendered markers following revert
- This gives UI time to start refreshing before we check for the new marker
- Fixes CI timing issue where revert operation needs more time to trigger UI refresh
* Update test log markers for git log refresh events
Replaces '[test-id-git-log-data-rendered]' with '[test-id-git-log-refreshed]' in gitLog.feature to better reflect UI refresh events after commit and revert actions. Adds a debug log marker '[test-id-git-revert-complete]' in revertCommit for improved test synchronization.
* Fix git revert refresh timing - remove intermediate step and rely on git-log-refreshed
* Add detailed logging to handleRevert for CI debugging
* Fix git log refresh by adding manual triggerRefresh fallback
- Add triggerRefresh function to useGitLogData hook for manual refresh
- Call triggerRefresh in handleCommitSuccess, handleRevertSuccess, and handleUndoSuccess
- This fixes cross-process IPC observable subscription issues where gitStateChange$
notifications from main process may not reach renderer process reliably
- Add detailed logging to handleRevert for CI debugging
* Update index.tsx
|
||
|---|---|---|
| .github | ||
| .vscode | ||
| build-resources | ||
| docs | ||
| features | ||
| localization | ||
| patches | ||
| scripts | ||
| src | ||
| template | ||
| tiddlers/subwiki | ||
| .editorconfig | ||
| .env | ||
| .gitattributes | ||
| .gitignore | ||
| .gitmodules | ||
| .npmrc | ||
| .nvmrc | ||
| .pnpmfile.cjs | ||
| dprint.json | ||
| eslint.config.mjs | ||
| forge.config.ts | ||
| forge.env.d.ts | ||
| index.html | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| PrivacyPolicy.md | ||
| README.md | ||
| reviewpad.yml | ||
| tsconfig.json | ||
| tsconfig.test.json | ||
| vite.main.config.ts | ||
| vite.preload.config.ts | ||
| vite.renderer.config.ts | ||
| vite.worker.config.ts | ||
| vitest.config.ts | ||
TidGi
Customizable personal knowledge-base with git as backup manager and blogging platform.
Pronounce: Same as Tai Chi /ˌtaɪ ˈtʃiː/
🇬🇧 English | 🇨🇳 简体中文
ShowCases And Demo
Demo
Screenshot
| Load NodeJS Wiki |
|---|
 |
| Create Local Wiki | Clone Online Wiki |
|---|---|
 |
 |
| Translation, Preferences |
|---|
 |
| Interactive code |
 |
| Community Plugin Library |
 |
For mac users, since I haven't buy Apple developer key yet, so you have to entrust App to open it, click here to expand details.◀
First of all, you need to drag this App into Applications folder! Otherwise there will be an error.
Click "Cancel" ↓
Click "Open" ↓
Click "OK" ↓
Related Posts About TidGi
No English posts yet...Please help sharing!
About TidGi-Desktop
TidGi 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.
You can call it TG-Note, it is totally free and you own all your data. Code by the people, build for the people.
It used to named TiddlyGit, means TiddlyWiki with easy Git backup, short for TidGi now.
Download
For Windows MacOS normal user
| Download |
|---|
 |
For arch user
yay tidgi
For MacOS CLI user
brew install TidGi # Not tested
Mobile App
- TidGi-Mobile is the official pair with TidGi-Desktop, developed by @linonetwo, fast for 100MB+ wiki.
- See Tiddloid for Android App developed by @donmor. Good for smaller wiki, and you can have access to your HTML wiki.
You can switch between them, and sync data between them and TidGi at any time. All of them are local-first, open-sourced and compatible with TiddlyWiki ecosystem.
Data Privacy Protection
You can choose storage provider for your wiki workspace:
- "Github" as unlimited storage and gh-pages blogging platform.
- "Local" will create a local git repo for you, you can use GithubDesktop to sync manually.
- "Gitlab" and "Gitee" is on the way
Differences
Differences from TiddlyDesktop?
- 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
- 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)
- Though TiddlyDesktop can also load wiki folder generated by nodejs-TiddlyWiki, TG can backup that folder to the Github easily
- With the Electron technology, we can use
fs,gitand many other nodejs things within TiddlyWiki, which greatly extend the hackability, which is the reason why I choose TiddlyWiki as my daily KM tool
Why Github?
Because Github is one of the best free civil level BaaS:
- Its storage is basically free, allow us to store unlimited images and PDF files, which can have permanent URIs for public download
- It has GraphQL API that allow us programmatically update our wiki
- It has free CI to automatically deploy our TiddlyWiki blog
- It provides unlimited repository, public and private, which enables us to store private content into our TiddlyWiki
Development
Read Dev doc for details.
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 TidGi.
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.
Stargazers over time
Please give a star if you like it!
