TNotes.introduction

Appearance

0001. TNotes 简介

0001. TNotes 简介 ​

1. 🎯 本节内容 ​

  • TNotes 简介

2. 🫧 评价 ​

对 TNotes 做一个简单的介绍。

笔记简介
0028.TNotes 根知识库本文介绍了 TNotes 根知识库的首页结构、功能定位以及历史版本演进过程。
0014.分仓库模式本文介绍了 TNotes 采用分仓库模式管理笔记的原因、知识库划分标准以及如何创建和查看知识库。
0002.TNotes 公式支持本文介绍了 TNotes 对数学公式的支持，通过集成 markdown-it-mathjax3 实现了 LaTeX 公式渲染功能，并提供了测试用例验证其正确性。
0027.TNotes 中常用的 emoji本文介绍了 TNotes 中常用的 emoji 表情符号及其含义，用于在笔记中直观地表示不同类型的内容和用途。

3. 🤔 TNotes 是什么？ ​

foot print
  • TNotes（Tdahuyou の Notes） 是一个基于开源项目和免费工具（比如：vitepress、github pages、giscus、markdown-it ……）实现的一个用于快速搭建个人在线开源知识库的免费工具。
  • 但凡是在 TNotes 中能看到的内容，均已开源在 tnotesjs github 上，有需要的可自行 clone。
  • TNotes 诞生时间是 -> 24.08.28，是目前记录笔记所用的主要工具，在使用过程中会根据痛点不断完善。

4. 🤔 TNotes 中的「知识库」、「笔记」指的是什么？ ​

  • 「知识库」本质上就是一个简单的 git 仓库。
  • 「笔记」是在知识库的 notes 目录下存放着一系列从 0001-9999 为编号的目录。
  • 「笔记 ID」是笔记目录前边儿的 0001-9999 四个数字组成的编号。

5. 🤔「知识库」基本结构是？ ​

  • 这里以当前 TNotes.introduction 这个知识库为例，对其中的核心文件、目录做一个简单介绍：
bash
# .
# ├── .vscode
# │   ├── settings.json
# │   └── tasks.json
# ├── index.md
# ├── MERGED_README.md
# ├── notes
# │   ├── 0001. TNotes 简介
# │   ├── 0002. 公式
# │   ├── 0003. mermaid 图表
# │   ├── 0004. swiper
# │   ├── 0005. BilibiliOutsidePlayer
# │   ├── 0006. Footprints
# │   ├── 0007. 根知识库首页样式优化
# │   ├── 0008. 知识库首页样式优化
# │   ├── 0009. 优化搜索配置
# │   ├── 0010. EnWordList
# │   └── ……
# ├── package.json
# ├── README.md
# └── sidebar.json
  • .vscode
    • settings.json 存放 VSCode 的配置文件
    • tasks.json 封装了一些任务，方便在 VSCode 中调用
  • index.md
    • vitepress 主页
  • MERGED_README.md
    • 这是 tn:merge 操作生成的所有 notes 目录下合并后的笔记内容。
    • 可以将所有的笔记内容汇总到一篇笔记中，是早期用于统一处理一些格式的时候用的，后续基本没再使用。
    • 相关命令：
      • pnpm tn:merge -> 笔记合并到一个文件 MERGED_README.md 中
      • pnpm tn:distribute -> 将合并后的笔记 MERGED_README.md 分发到对应的笔记中
  • notes
    • 存放笔记的目录
  • package.json
    • 记录项目依赖，封装一些 scripts 命令
  • README.md
    • 知识库首页的 README.md 文件，有指定的书写格式要求，TNotes 会自动解析这里边儿的节点来生成目录。
  • sidebar.json
    • vitepress 中的侧边栏目录的配置文件，由 TNotes 自动生成。

6. 🤔 TNotes 有什么用？ ​

  • 1️⃣ 通过脚本来自动管理这些笔记，比如：
    • 解析根目录下的 README.md 中的内容，生成整个知识库的目录及首页的目录视图；
    • 解析笔记配置 .tnotes.json，管理笔记的状态；
    • ……
  • 2️⃣ 自定义组件，扩展 markdown 功能，比如：
    • swiper 图片分页组件；
    • markmap 思维导图组件；
    • ……
  • 3️⃣ layout 自定义布局
    • 侧边栏折叠功能；
    • 全屏显示功能；
    • 解析笔记路径，实现快速使用 VSCode 打开对应笔记的功能；
    • ……
  • 4️⃣ 评论功能

7. 🤔 TNotes 中「知识库」的类型及其之间的关系是？ ​

  • 目前在 TNotes 中只有两种类型的知识库：根知识库 和 子知识库。
    • 根知识库：只有一个
    • 子知识库：可以有多个
    • 比如：下图中 notes 就是根知识库，其余的都是子知识库。
    • img
  • 根知识库会自动收集所有子知识库的目录信息，在 TNotes 首页 解析为目录视图，以便快速定位所有笔记。

8. 🤔 如何搜到 TNotes？ ​

  • 这是当前 TNotes 的地址：https://tnotesjs.github.io/TNotes/
  • 尝试对 Google Chrome 和 Microsoft Bing 的搜索做了 SEO 优化，你可以通过关键字 github ➕ tnotesjs 快速搜到该站点。
1
2

9. 🤔 TNotes 的 logo 是？ ​

  • 图 1
  • 这是大二 👣 7291 | 2019-06-14 16:52 去学校附近的海边拍的脚印，是第一条朋友圈发的图，也是朋友圈的封面，就暂且拿它来做 TNotes 的 logo 吧。
  • 你可以在 TNotes.footprints 中记录的我的 2019 年的动态中看到那条朋友圈。

10. 🤔 目前 TNotes 中都打算记录哪些内容？ ​

  • TNotes 主要用来汇总个人写的一些学习笔记。
  • 除了学习笔记之外，也会记录一些其他乱七八糟的内容，比如：
    • 随笔
    • 做饭
    • 个人动态
    • 阅读过的书籍
    • 看过的电影
    • 追过的番
    • 自己写的一些开源项目
    • ... 等等
  • 目前（25）正在逐步搬运个人的学习笔记到 TNotes 中。
    • 已完成搬运的，会在对应的笔记标题前边 ✅ 打勾。

11. 🔗 引用 ​

Discussions