add project wiki github pages

This commit is contained in:
wanxp 2024-05-11 16:54:01 +08:00
parent cf938779dd
commit 40c8f387c3
20 changed files with 93 additions and 46 deletions

@ -1,6 +1,6 @@
---
title: 如何安装
layout: home
layout: default
nav_order: 200
---

@ -1,17 +1,6 @@
---
title: 如何使用
layout: home
layout: default
nav_order: 300
has_children: true
---
## 如何使用
## 搜索
使用方式: 输入<kbd>Ctrl</kbd> + <kbd>P</kbd>输入“豆瓣”或“Douban”选择搜索并使用
- 搜索数据并创建笔记
- 通过当前文件名搜索
- 通过输入文本搜索
![search_and_create](img/search_and_create_note.gif)
## 同步
- 同步个人的观影、观剧、阅读、游戏、音乐记录
![Sync Data From Douban](img/sync_data_from_douban.gif)

@ -0,0 +1,18 @@
---
title: 使用说明
layout: default
nav_order: 300
parent: 如何使用
---
## 如何使用
## 搜索
使用方式: 输入<kbd>Ctrl</kbd> + <kbd>P</kbd>输入“豆瓣”或“Douban”选择搜索并使用
- 搜索数据并创建笔记
- 通过当前文件名搜索
- 通过输入文本搜索
![search_and_create](img/search_and_create_note.gif)
## 同步
- 同步个人的观影、观剧、阅读、游戏、音乐记录
![Sync Data From Douban](img/sync_data_from_douban.gif)

@ -1,7 +1,8 @@
---
title: 设置
layout: home
layout: default
nav_order: 350
parent: 如何使用
---
## 设置

@ -1,12 +1,6 @@
---
title: 功能
layout: home
layout: default
nav_order: 400
has_children: true
---
## 功能
- ☑️ 导入电影、电视剧、书籍、音乐、游戏、日记
- ☑️ 同步个人听过/看过的电影、电视剧、书籍、音乐
- ☑️ 导入个人的评论,评论时间,阅读状态,个人评分
- ☑️ 支持保存封面至本地
- ☑️ 支持自定义参数

12
doc/30_function_10.md Normal file

@ -0,0 +1,12 @@
---
title: 基础功能
layout: default
nav_order: 400
parent: 功能
---
## 功能
- ☑️ 导入电影、电视剧、书籍、音乐、游戏、日记
- ☑️ 同步个人听过/看过的电影、电视剧、书籍、音乐
- ☑️ 导入个人的评论,评论时间,阅读状态,个人评分
- ☑️ 支持保存封面至本地
- ☑️ 支持自定义参数

@ -1,7 +1,8 @@
---
title: 支持的参数
layout: home
layout: default
nav_order: 500
parent: 功能
---
## 支持的字段

@ -1,13 +1,6 @@
---
title: 特殊效果
layout: home
layout: default
nav_order: 450
has_children: true
---
## 效果
1. 结合Timeline插件 __构建个人观影时间线__,请参照[结合timeline插件实现时间线效果](./Obsidian-Douban-TimeLine.md)
![](./img/obsidian-douban-time-preview-example.gif)
<!--2. 结合DataView插件__构建个人电子书架书库数据__请参照[结合dateview插件实现个人书架效果](./doc/Obsidian-Douban-DataView.md))-->
2. 结合主题 __构建类豆瓣网页效果__,请参照[结合Blue Topaz实现网页效果](./Obsidian-Douban-BlueTopaz.md)
![](./background.png)

13
doc/60_special_use_10.md Normal file

@ -0,0 +1,13 @@
---
title: 效果介绍
layout: default
nav_order: 450
parent: 特殊效果
---
## 效果
1. 结合Timeline插件 __构建个人观影时间线__,请参照[结合timeline插件实现时间线效果](Obsidian-Douban-TimeLine)
![](./img/obsidian-douban-time-preview-example.gif)
<!--2. 结合DataView插件__构建个人电子书架书库数据__请参照[结合dateview插件实现个人书架效果](Obsidian-Douban-DataView.md))-->
2. 结合主题 __构建类豆瓣网页效果__,请参照[结合Blue Topaz实现网页效果](Obsidian-Douban-BlueTopaz)
![](./background.png)

@ -1,6 +1,6 @@
---
title: 开发
layout: home
layout: default
nav_order: 700
---

7
doc/80_others.md Normal file

@ -0,0 +1,7 @@
---
title: 其它
layout: default
nav_order: 750
has_children: true
---

@ -1,7 +1,8 @@
---
title: 数据影响
layout: home
nav_order: 600
layout: default
nav_order: 800
parent: 其它
---
## 数据影响

@ -1,7 +1,8 @@
---
title: 鸣谢
layout: home
nav_order: 800
layout: default
nav_order: 810
parent: 其它
---
## 鸣谢
### IDE支持

@ -1,7 +1,8 @@
---
title: 免责声明
layout: home
nav_order: 900
layout: default
nav_order: 820
parent: 其它
---
## 免责声明

10
doc/97_issues.md Normal file

@ -0,0 +1,10 @@
---
title: 反馈与建议
layout: default
nav_order: 950
---
## 反馈与建议
如果你有任何问题或建议,欢迎在提交[Issues](https://github.com/Wanxp/obsidian-douban/issues)

@ -1,10 +1,14 @@
---
title: 支持
layout: home
layout: default
nav_order: 1000
---
## 支持
愿世界充满爱!
愿世界充满爱与和平!
## 交流社群
<img src="img/obsidian-douban-qq-qr_code.svg" width="300px">
[邮件联系我](mailto:977741432@qq.com)

@ -1,6 +1,6 @@
---
title: 类豆瓣网页显示
layout: home
layout: default
nav_order: 455
parent: 特殊效果
render_with_liquid: false

@ -1,6 +1,6 @@
---
title: 看剧时间线
layout: home
layout: default
nav_order: 456
parent: 特殊效果
render_with_liquid: false

@ -6,3 +6,5 @@ url: https://wanxp.github.io/obsidian-douban
aux_links: # remove if you don't want this link to appear on your pages
Github Repository: https://github.com/Wanxp/obsidian-douban
search:
focus_shortcut_key: 'k'

@ -1,12 +1,12 @@
---
title: 简介
layout: home
nav_order: 100
nav_order: 10
---
这是一款[Obsidian](https://obsidian.md/)的插件, 用于导入[豆瓣](https://www.douban.com/)中的 _电影、书籍、音乐、电视剧、日记、游戏_
甚至是 _你标记过的书影音_ , 包含你的评分、观看日期、评论、阅读状态等信息.
这是一款[Obsidian](https://obsidian.md/)的插件, 用于导入[豆瓣](https://www.douban.com/)中的 _电影、书籍、音乐、电视剧、日记、游戏
甚至是你标记过的书影音, 包含你的评分、观看日期、评论、阅读状态等信息.
![background](./background.png)