mirror of
https://github.com/Wanxp/obsidian-douban.git
synced 2026-04-04 08:38:41 +08:00
add readme
This commit is contained in:
parent
f522bf4a6d
commit
2c62b5b44a
159
README.md
159
README.md
@ -1,30 +1,28 @@
|
||||
# Obsidian Douban Plugin
|
||||
|
||||
<p align="center">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/releases/latest">
|
||||
<img src="https://img.shields.io/github/manifest-json/v/Wanxp/obsidian-douban?color=blue">
|
||||
</a>
|
||||
<img src="https://img.shields.io/github/release-date/Wanxp/obsidian-douban">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/blob/master/License">
|
||||
<img src="https://img.shields.io/github/license/Wanxp/obsidian-douban">
|
||||
</a>
|
||||
<img src="https://img.shields.io/github/downloads/Wanxp/obsidian-douban/total">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/issues">
|
||||
<img src="https://img.shields.io/github/issues/Wanxp/obsidian-douban">
|
||||
</a>
|
||||
<br>
|
||||
<img src="https://img.shields.io/tokei/lines/github/Wanxp/obsidian-douban">
|
||||
<a href="https://www.codefactor.io/repository/github/wanxp/obsidian-douban">
|
||||
<img src="https://www.codefactor.io/repository/github/wanxp/obsidian-douban/badge" alt="CodeFactor" />
|
||||
</a>
|
||||
</p>
|
||||
<p align="center">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/releases/latest">
|
||||
<img src="https://img.shields.io/github/manifest-json/v/Wanxp/obsidian-douban?color=blue">
|
||||
</a>
|
||||
<img src="https://img.shields.io/github/release-date/Wanxp/obsidian-douban">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/blob/master/License">
|
||||
<img src="https://img.shields.io/github/license/Wanxp/obsidian-douban">
|
||||
</a>
|
||||
<img src="https://img.shields.io/github/downloads/Wanxp/obsidian-douban/total">
|
||||
<a href="https://github.com/Wanxp/obsidian-douban/issues">
|
||||
<img src="https://img.shields.io/github/issues/Wanxp/obsidian-douban">
|
||||
</a>
|
||||
<br>
|
||||
<img src="https://img.shields.io/tokei/lines/github/Wanxp/obsidian-douban">
|
||||
<a href="https://www.codefactor.io/repository/github/wanxp/obsidian-douban">
|
||||
<img src="https://www.codefactor.io/repository/github/wanxp/obsidian-douban/badge" alt="CodeFactor" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
Import Movie, Book, Music, Teleplay, Note, Game even Broadcast Data from Douban in [Obsidian](https://obsidian.md/)
|
||||
在[Obsidian](https://obsidian.md/)使用并导入豆瓣中的电影/书籍/音乐/电视剧/日记/游戏甚至是广播, 包含评分/发布日期/演员表等信息, 登录后还有个人阅读状态等信息
|
||||
|
||||
|
||||
---
|
||||
If you want some features or have any questions about this plugin, create issues or join the development is welcome.
|
||||
Import Movie, Book, Music, Teleplay, Note, Game even Broadcast Data from Douban in [Obsidian](https://obsidian.md/)
|
||||
在[Obsidian](https://obsidian.md/)使用并导入豆瓣中的电影/书籍/音乐/电视剧/日记/游戏甚至是广播, 包含评分/发布日期/演员表等信息, 登录后还有个人阅读状态等信息 
|
||||
|
||||
--- If you want some features or have any questions about this plugin, create issues or join the development is welcome.
|
||||
关于当前的插件如果有任何疑问, 缺少想要的导入内容或者想要什么功能, 欢迎提issues或加入到开发当中.
|
||||
|
||||
- [Bugs, Issues, & Feature Requests](https://github.com/Wanxp/obsidian-douban/issues)
|
||||
@ -45,57 +43,62 @@ If you want some features or have any questions about this plugin, create issues
|
||||
|
||||
## Support Field/支持的字段
|
||||
(若有缺少想导入的字段, 欢迎提issues反馈)
|
||||
|
||||
---
|
||||
| 字段 | 电影 | 电视剧 | 书籍 | 音乐 | 日记 | 游戏 | 广播 |
|
||||
| ----------- | -------------------- | -------------------- |-------------------| ------------------ | ------------------ | ---------------- | ---- |
|
||||
| id | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | - |
|
||||
| title | 电影名称 | 电视剧名称 | 书名 | 音乐名 | 日记标题 | 游戏名称 | - |
|
||||
| type | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 | - |
|
||||
| score | 评分 | 评分 | 评分 | 评分 | 评分 | 评分 | - |
|
||||
| image | 封面 | 封面 | 封面 | 封面 | 图片 | 封面 | - |
|
||||
| url | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | - |
|
||||
| desc | 简介 | 简介 | 内容简介 | 简介 | 简介 | 简介 | - |
|
||||
| publisher | - | - | 出版社 | 出版者 | 发布者 | 发行商 | - |
|
||||
| datePublished | 上映日期 | 上映日期 | 出版年 | 发行时间 | 发布时间 | 发行日期 | - |
|
||||
| genre | 类型 | 类型 | - | 流派 | - | 类型 | - |
|
||||
| currentDate | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | |
|
||||
| currentTime | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | |
|
||||
| 扩展1 | director:导演 | director:导演 | author:原作者 | actor: 表演者 | author:作者 | aliases:别名 | |
|
||||
| 扩展2 | author:编剧 | author:编剧 | translator:译者 | albumType:专辑类型 | authorUrl:作者网址 | developer:开发商 | |
|
||||
| 扩展3 | actor:主演 | actor:主演 | isbn:isbn | medium:介质 | content:日记内容 | platform:平台 | |
|
||||
| 扩展4 | originalTitle:原作名 | originalTitle:原作名 | originalTitle:原作名 | records:唱片数 | | | |
|
||||
| 扩展5 | | | subTitle:副标题 | barcode:条形码 | | | |
|
||||
| 扩展6 | | | totalPage:页数 | | | | |
|
||||
| 扩展7 | | | series:丛书 | | | | |
|
||||
| 扩展8 | | | menu:目录 | | | | |
|
||||
| 扩展9 | | | price:定价 | | | | |
|
||||
| 扩展7 | | | binding:装帧 | | | | |
|
||||
| 扩展8 | | | producer: 出品方 | | | | |
|
||||
|
||||
| 字段 | 电影 | 电视剧 | 书籍 | 音乐 | 日记 | 游戏 | 广播 | 备注 |
|
||||
| ---------------- | -------------------- | -------------------- | -------------------- | ------------------- | ------------------ | ------------------- | ---- | ---- |
|
||||
| id | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | 豆瓣ID | - | |
|
||||
| title | 电影名称 | 电视剧名称 | 书名 | 音乐名 | 日记标题 | 游戏名称 | - | |
|
||||
| type | 类型 | 类型 | 类型 | 类型 | 类型 | 类型 | - | |
|
||||
| score | 评分 | 评分 | 评分 | 评分 | 评分 | 评分 | - | |
|
||||
| image | 封面 | 封面 | 封面 | 封面 | 图片 | 封面 | - | |
|
||||
| url | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | 豆瓣网址 | - | |
|
||||
| desc | 简介 | 简介 | 内容简介 | 简介 | 简介 | 简介 | - | |
|
||||
| publisher | - | - | 出版社 | 出版者 | 发布者 | 发行商 | - | |
|
||||
| datePublished | 上映日期 | 上映日期 | 出版年 | 发行时间 | 发布时间 | 发行日期 | - | |
|
||||
| genre | 类型 | 类型 | - | 流派 | - | 类型 | - | |
|
||||
| currentDate | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | 今日日期 | | |
|
||||
| currentTime | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | 当前时间 | | |
|
||||
| myTags | 我标记的标签 | 我标记的标签 | 我标记的标签 | 我标记的标签 | - | 我标记的标签 | | 登录后可用 |
|
||||
| myRating | 我的评分 | 我的评分 | 我的评分 | 我的评分 | - | 我的评分 | | 登录后可用 |
|
||||
| myState | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想看/在看/看过 | 状态:想听/在听/听过 | - | 状态:想玩/在玩/玩过 | | 登录后可用|
|
||||
| myComment | 我的评语 | 我的评语 | 我的评语 | 我的评语 | - | 我的评语 | | 登录后可用 |
|
||||
| myCollectionDate | 我标记的时间 | 我标记的时间 | 我标记的时间 | 我标记的时间 | - | 我标记的时间 | | 登录后可用 |
|
||||
| 扩展1 | director:导演 | director:导演 | author:原作者 | actor: 表演者 | author:作者 | aliases:别名 | | |
|
||||
| 扩展2 | author:编剧 | author:编剧 | translator:译者 | albumType:专辑类型 | authorUrl:作者网址 | developer:开发商 | | |
|
||||
| 扩展3 | actor:主演 | actor:主演 | isbn:isbn | medium:介质 | content:日记内容 | platform:平台 | | |
|
||||
| 扩展4 | originalTitle:原作名 | originalTitle:原作名 | originalTitle:原作名 | records:唱片数 | | | | |
|
||||
| 扩展5 | | | subTitle:副标题 | barcode:条形码 | | | | |
|
||||
| 扩展6 | | | totalPage:页数 | | | | | |
|
||||
| 扩展7 | | | series:丛书 | | | | | |
|
||||
| 扩展8 | | | menu:目录 | | | | | |
|
||||
| 扩展9 | | | price:定价 | | | | | |
|
||||
| 扩展7 | | | binding:装帧 | | | | | |
|
||||
| 扩展8 | | | producer: 出品方 | | | | | |
|
||||
|
||||
|
||||
|
||||
|
||||
## How to use
|
||||
### Search
|
||||
- Search Data And Create Note
|
||||
搜索数据并创建笔记
|
||||
|
||||
- Search Data By File Name
|
||||
通过当前文件名搜索
|
||||
- Search Data And Create Note
|
||||
搜索数据并创建笔记
|
||||
|
||||
- Search Data By File Name
|
||||
通过当前文件名搜索
|
||||
|
||||
|
||||
- Search Movie By Input Text
|
||||
通过输入文本搜索
|
||||
- Search Movie By Input Text
|
||||
通过输入文本搜索
|
||||
|
||||
|
||||
## Settings
|
||||
- Setting Example1(Custom Template)
|
||||
设置案例1(自定义模板)
|
||||
- Setting Example1(Custom Template)
|
||||
设置案例1(自定义模板)
|
||||
|
||||
|
||||
|
||||
- Setting Example2(Other Settings)
|
||||
设置案例2(其它配置)
|
||||
- Setting Example2(Other Settings)
|
||||
设置案例2(其它配置)
|
||||
|
||||
|
||||
|
||||
@ -107,9 +110,8 @@ If you want some features or have any questions about this plugin, create issues
|
||||
1. Go to Obsidian plugin center
|
||||
2. Search obsidian-douban
|
||||
3. Click install
|
||||
4. Enable plugin
|
||||
---
|
||||
### 从Obsidian插件中心
|
||||
4. Enable plugin
|
||||
--- ### 从Obsidian插件中心
|
||||
1. 进入Obsidian插件中心
|
||||
2. 搜索obsidian-douban
|
||||
3. 安装
|
||||
@ -118,34 +120,32 @@ If you want some features or have any questions about this plugin, create issues
|
||||
### Manmel
|
||||
1. Download `main.js`, `manifest.json`, `styles.css` from GitHub release page
|
||||
2. Copy step1 downloaded file to your vault folder `/.obsidian/plugins/obsidian-douban/`
|
||||
3. Enable plugin in Obsidian
|
||||
----
|
||||
### 手动安装
|
||||
3. Enable plugin in Obsidian
|
||||
---- ### 手动安装
|
||||
1. 从Github release 页面下载 `main.js`, `manifest.json`, `styles.css`
|
||||
2. 将下载的文件复制到你的Obsidian文档根目录下的`/.obsidian/plugins/obsidian-douban`路径,若不存在则新建文件夹(注意.obsidian文件夹可能是个隐藏为文件夹)
|
||||
3. 在obsidian插件中心开启当前插件功能
|
||||
|
||||
## How to Develop
|
||||
1. Enter your test vault folder `/.obsidian/plugins/`
|
||||
2. Clone Code
|
||||
2. Clone Code
|
||||
`git clone git@github.com:Wanxp/obsidian-douban.git`
|
||||
3. Enter folder
|
||||
3. Enter folder
|
||||
`cd obsidian-douban`
|
||||
4. Build
|
||||
4. Build
|
||||
`npm run build`
|
||||
5. Run and Watch code chang
|
||||
5. Run and Watch code chang
|
||||
`npm run dev`
|
||||
6. Go to your Obsidian plugin center reload this plugin
|
||||
7. Enjoy your develop
|
||||
---
|
||||
1. 进入你的Obsidian测试文档文件夹下的`/.obsidian/plugins/`
|
||||
2. 克隆代码
|
||||
7. Enjoy your develop
|
||||
--- 1. 进入你的Obsidian测试文档文件夹下的`/.obsidian/plugins/`
|
||||
2. 克隆代码
|
||||
`git clone git@github.com:Wanxp/obsidian-douban.git`
|
||||
3. 进入代码文件夹
|
||||
3. 进入代码文件夹
|
||||
`cd obsidian-douban`
|
||||
4. 构建
|
||||
4. 构建
|
||||
`npm run build`
|
||||
5. 运行
|
||||
5. 运行
|
||||
`npm run dev`
|
||||
6. 进入Obsidian插件中心重新加载当前插件
|
||||
7. 享受开发吧
|
||||
@ -153,4 +153,3 @@ If you want some features or have any questions about this plugin, create issues
|
||||
## 免责声明
|
||||
1. 本程序没有爬取任何书影音等内容，只供技术研究使用。没有侵犯书影音作者版权和豆瓣官方利益。如有任何侵权行为，请联系我删除。
|
||||
## Thanks
|
||||
|
||||
|
||||
Loading…
Reference in New Issue
Block a user