154 lines
4.3 KiB
Markdown
154 lines
4.3 KiB
Markdown
<div align="center">
|
|
|
|
<img src="attches/logo.png" alt="Logo" width="80" height="80">
|
|
|
|
# 📚 OneforAll - Obsidian 文档仓库
|
|
|
|
[](https://gitea.io/)
|
|
[](https://obsidian.md/)
|
|
[](https://git-scm.com/)
|
|
[](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/) |