TidGi-Desktop 安装与使用教程

TidGi-Desktop 安装与使用教程

TidGi-DesktopTidGi 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) 项目地址:https://gitcode.com/gh_mirrors/ti/TidGi-Desktop

1. 项目目录结构及介绍

在下载并解压TidGi-Desktop源代码后，你会看到以下主要的目录结构：

• app: 这是应用程序的核心目录，包含了TiddlyWiki相关的数据和配置。
• dist: 此目录用于存放编译后的可执行文件，供最终用户使用。
• node_modules: 存储所有依赖的npm模块。
• src: 源代码所在的目录，包含了界面UI以及程序逻辑。
  • main.js: 主进程脚本，负责应用程序的初始化和后台操作。
  • renderer.js: 渲染进程脚本，处理用户界面交互和视图更新。
• .gitignore: 用于指定git版本控制忽略的文件或目录。
• package.json: 项目元数据和npm包依赖的描述文件。

2. 项目的启动文件介绍

• package.json 中定义了两个重要的脚本：
  • npm start: 启动开发者模式的应用程序，具有热重载和调试功能。
  • npm run build: 编译源码并打包到dist目录，生成可发布版本。

要运行TidGi-Desktop，首先确保你已全局安装npm（Node Package Manager）。然后在项目根目录下执行以下命令：

# 安装项目依赖
npm install

# 开发者模式启动
npm start

这将启动应用程序，并实时监控源代码变化以自动重新构建。

若要创建生产环境的构建：

# 构建发行版
npm run build

完成后，dist目录将包含对应平台的可执行文件。

3. 项目的配置文件介绍

TidGi-Desktop的配置文件主要位于src目录下的main-process子目录中，具体包括：

• config.js: 应用的基础配置文件，这里设置了一些默认值和全局变量。
• settings.json: 用户设定文件，保存用户的个性化设置，如默认语言、启动选项等。

这些配置文件会被加载到应用程序中，从而影响其行为和外观。如果你想要自定义TidGi的行为，可以在这里进行修改。

请注意，对配置文件的修改可能需要重新启动应用才能生效。请根据你的需求谨慎调整，并在编辑前备份原有的配置。

TidGi-DesktopTidGi 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) 项目地址:https://gitcode.com/gh_mirrors/ti/TidGi-Desktop