feat: 初始化 Obsidian 文档仓库并配置项目结构

- 创建完整的 README.md 文档,包含仓库介绍、使用指南和规范说明
- 添加项目 Logo 图片资源到 attches 目录
- 配置 .gitignore 文件以排除不必要的文件
- 新增 .obsidian/.gitignore 排除工作区配置文件
- 删除默认的欢迎页面和旧的工作区配置文件
- 建立标准化的文档仓库结构,支持多设备同步和版本控制
This commit is contained in:
drd_vic
2025-11-27 21:00:26 +08:00
parent 00d67db9e8
commit ff080b32bf
6 changed files with 155 additions and 212 deletions

0
.gitignore vendored Normal file
View File

1
.obsidian/.gitignore vendored Normal file
View File

@@ -0,0 +1 @@
workspace.json

View File

@@ -1,207 +0,0 @@
{
"main": {
"id": "2dcdc3ae101bd346",
"type": "split",
"children": [
{
"id": "94f0f9c7235363d3",
"type": "tabs",
"children": [
{
"id": "49279288ab986bdb",
"type": "leaf",
"state": {
"type": "empty",
"state": {},
"icon": "lucide-file",
"title": "新标签页"
}
}
]
}
],
"direction": "vertical"
},
"left": {
"id": "4760e9a07ab4c7c2",
"type": "split",
"children": [
{
"id": "3a11b34973c5ac1c",
"type": "tabs",
"children": [
{
"id": "aa672fbbff8a8739",
"type": "leaf",
"state": {
"type": "file-explorer",
"state": {
"sortOrder": "alphabetical",
"autoReveal": false
},
"icon": "lucide-folder-closed",
"title": "文件列表"
}
},
{
"id": "fd923bf2b585a99d",
"type": "leaf",
"state": {
"type": "search",
"state": {
"query": "",
"matchingCase": false,
"explainSearch": false,
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical"
},
"icon": "lucide-search",
"title": "搜索"
}
},
{
"id": "c1f07d1cef218e2e",
"type": "leaf",
"state": {
"type": "bookmarks",
"state": {},
"icon": "lucide-bookmark",
"title": "书签"
}
}
]
}
],
"direction": "horizontal",
"width": 300
},
"right": {
"id": "623d818bcdac044f",
"type": "split",
"children": [
{
"id": "d2a3b71c65e210ab",
"type": "tabs",
"children": [
{
"id": "42eb10ca2c1a1ee9",
"type": "leaf",
"state": {
"type": "backlink",
"state": {
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical",
"showSearch": false,
"searchQuery": "",
"backlinkCollapsed": false,
"unlinkedCollapsed": true
},
"icon": "links-coming-in",
"title": "反向链接"
}
},
{
"id": "16533cfe62297923",
"type": "leaf",
"state": {
"type": "outgoing-link",
"state": {
"linksCollapsed": false,
"unlinkedCollapsed": true
},
"icon": "links-going-out",
"title": "出链"
}
},
{
"id": "4e9dc0b507cde941",
"type": "leaf",
"state": {
"type": "tag",
"state": {
"sortOrder": "frequency",
"useHierarchy": true,
"showSearch": false,
"searchQuery": ""
},
"icon": "lucide-tags",
"title": "标签"
}
},
{
"id": "f6dc667c1e0fc034",
"type": "leaf",
"state": {
"type": "all-properties",
"state": {
"sortOrder": "frequency",
"showSearch": false,
"searchQuery": ""
},
"icon": "lucide-archive",
"title": "添加笔记属性"
}
},
{
"id": "8c20dbd673e2df49",
"type": "leaf",
"state": {
"type": "outline",
"state": {
"followCursor": false,
"showSearch": false,
"searchQuery": ""
},
"icon": "lucide-list",
"title": "大纲"
}
},
{
"id": "173bfddee82444a9",
"type": "leaf",
"state": {
"type": "git-view",
"state": {},
"icon": "git-pull-request",
"title": "Source Control"
}
},
{
"id": "ae641b007a45f628",
"type": "leaf",
"state": {
"type": "footnotes",
"state": {},
"icon": "lucide-file-signature",
"title": "脚注"
}
}
],
"currentTab": 5
}
],
"direction": "horizontal",
"width": 300
},
"left-ribbon": {
"hiddenItems": {
"obsidian-importer:Open Importer": false,
"switcher:打开快速切换": false,
"graph:查看关系图谱": false,
"canvas:新建白板": false,
"daily-notes:打开/创建今天的日记": false,
"templates:插入模板": false,
"command-palette:打开命令面板": false,
"bases:创建新数据库": false,
"obsidian-git:Open Git source control": false,
"publish:发布更改": false,
"workspaces:管理工作区布局": false
}
},
"active": "173bfddee82444a9",
"lastOpenFiles": [
"欢迎.md"
]
}

154
README.md Normal file
View File

@@ -0,0 +1,154 @@
<div align="center">
![Logo](.\\attches\\Logo.png "OneforAll 仓库 Logo")
# 📚 OneforAll - Obsidian 文档仓库
[![Gitea Version](https://img.shields.io/badge/Gitea-1.25.2-blue?style=flat-square\&logo=gitea)](https://gitea.io/)
[![Obsidian Compatible](https://img.shields.io/badge/Obsidian-Compatible-green?style=flat-square\&logo=obsidian)](https://obsidian.md/)
[![Git Version Control](https://img.shields.io/badge/Git-Version%20Control-orange?style=flat-square\&logo=git)](https://git-scm.com/)
[![Markdown Supported](https://img.shields.io/badge/Markdown-Supported-blueviolet?style=flat-square\&logo=markdown)](https://www.markdownguide.org/)
</div>
欢迎来到 **OneforAll** 仓库!本仓库专为存放、管理和同步 Obsidian 知识库文档而创建,旨在提供一个集中化、可版本控制的 Obsidian 内容存储,支持多设备访问。
## 🔍 仓库核心信息
<div align="center">
| 项目 | 详情 |
|------|------|
| 仓库名称 | OneforAll |
| 仓库地址 | [https://drdfilenest.xyz:8443/root/OneforAll](https://drdfilenest.xyz:8443/root/OneforAll) |
| 托管平台 | Gitea|
| 核心用途 | Obsidian 文档版本控制、备份与多端同步 |
| 支持格式 | Markdown、媒体、数据库等 Obsidian 兼容资源 |
</div>
## 📖 什么是 Obsidian
Obsidian 是一款基于 **Markdown** 的本地知识库管理工具,适合构建个人笔记、研究资料、项目文档等结构化/非结构化知识体系。
本仓库直接存储 Obsidian 库的原始文件及相关资源,确保数据可追溯、可恢复,同时解决多设备同步浏览的痛点。
## 📂 仓库结构
```
OneforAll/
├── .git/
├── docs/ # Obsidian 文档目录
│ ├── *.md
│ └── ...
├── attches/ # 附件资源目录
│ ├── *.jpg
│ ├── *.pdf
│ ├── *.mp3
│ └── ...
├── media/ # 媒体资源目录
├── db/ # 数据库目录
│ ├── *.database
│ ├── *.db
│ ├── *.sqlite
│ └── ...
├── .gitignore
├── README.md # 本仓库说明文档
```
## 🚀 快速使用指南
### 1. 克隆仓库到本地
确保本地安装 Git 后,执行以下命令:
```bash
# 克隆仓库
git clone https://drdfilenest.xyz:8443/root/OneforAll.git
# 进入仓库目录
cd OneforAll
```
### 2. 关联 Obsidian 库
1. 打开 Obsidian 客户端
2. 点击「打开仓库」→ 选择克隆后的 `OneforAll` 文件夹
3. 等待加载完成,即可直接编辑笔记
#### 本地修改后推送到仓库(备份 / 同步)
```bash
# 查看修改内容
git status
# 添加所有修改文件
git add .
# 提交修改
git commit -m "feat: 添加XX | fix: 修改XX ..."
# 推送到远程仓库
git push origin main
```
#### 拉取远程更新
```bash
# 拉取最新内容
git pull origin main
```
### 4. 多设备访问规范
✅ 遵循「拉取→修改→提交→推送」流程,避免冲突
✅ 重要修改前先拉取远程最新版本
✅ 冲突时优先保留核心内容,参考 Git 冲突解决指南
## ⚠️ 注意事项
1. **配置同步说明**
⚙️ `.obsidian` 文件夹同步主题、插件配置,需确保本地 Obsidian 插件版本兼容
2. **提交信息规范**
<div align="center">
| 类型 | 说明 | 示例 |
| -------- | ---- | --------------------- |
| feat | 新增内容 | `feat: 新增数据分析读书笔记` |
| fix | 修复问题 | `fix: 修复双向链接失效` |
| docs | 文档更新 | `docs: 更新README使用指南` |
| refactor | 结构调整 | `refactor: 整理笔记分类文件夹` |
</div>
3. **网络要求**
🔒 推送 / 拉取需通过 HTTPS 协议
## 🔐 权限说明
* 仓库访问:根据 Gitea 配置,仓库需登录后访问
* 提交权限:仅授权用户可推送修改
* 登录方式:账号密码登录
## 📞 联系与支持
* 仓库管理员:[drd_vic](https://drdfilenest.xyz:8443/root)
* 问题反馈:在 Gitea 仓库 **工单** 板块提交,或联系管理员邮箱:[2912458403@qq.com](mailto:2912458403@qq.com)
* 相关文档:
* [Obsidian 官方文档](https://help.obsidian.md/)
* [Git 官方指南](https://git-scm.com/docs)
* [Gitea 使用文档](https://docs.gitea.com/)

BIN
attches/Logo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

View File

@@ -1,5 +0,0 @@
这是你的新*仓库*。
写点笔记,[[创建链接]],或者试一试[导入器](https://help.obsidian.md/Plugins/Importer)插件!
当你准备好了,就将该笔记文件删除,使这个仓库为你所用。