Enhance README with bilingual content and features

Updated README to include bilingual features and installation instructions.
This commit is contained in:
lxl448080113 2026-06-25 17:03:40 +08:00 committed by GitHub
parent 1cc7cb4c0a
commit c57f4b5c38
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -2,7 +2,9 @@
An Obsidian plugin for importing Xiaohongshu (小红书) notes into your vault with configurable default folders, configurable frontmatter fields, local image downloads, and video links.
## Features
一个用于将小红书笔记导入 Obsidian 的插件支持配置默认笔记文件夹、图片文件夹、Frontmatter 字段、本地图片下载,以及视频链接保存。
## Features/功能特性
- Import Xiaohongshu share text or note URLs directly into Obsidian
- Configure default note and image folders in plugin settings
@ -11,23 +13,40 @@ An Obsidian plugin for importing Xiaohongshu (小红书) notes into your vault w
- Download note images into your vault and write Markdown image links back into the note
- Keep videos as remote links instead of downloading large media files
## Installation
- 支持将小红书分享文本或笔记链接直接导入 Obsidian
- 支持在插件设置中配置默认笔记文件夹和图片文件夹
- 支持配置 Frontmatter 字段,包括字段顺序、启用状态和默认值
- 支持 Frontmatter 占位符:{{date}}、{{title}}、{{source}}、{{videoUrl}}
- 支持将笔记图片下载到本地库中,并在笔记正文中写入 Markdown 图片链接
- 视频内容保留为远程链接,不下载大型媒体文件
### Manual install
## Installation/安装方式
### Manual install/手动安装
1. Download `main.js`, `manifest.json`, and `styles.css` from the latest GitHub Release.
2. Create a folder named `xhs-importer` under your vault's `.obsidian/plugins/`.
3. Copy the three files into that folder.
4. Reload Obsidian and enable **Xiaohongshu Importer Plus** in Community Plugins.
### GitHub Release install
1. 从最新的 GitHub Release 中下载 main.js、manifest.json 和 styles.css。
2. 在你的 Obsidian 库中创建以下插件文件夹
3. 将上述三个文件复制到该文件夹中。
4. 重新加载 Obsidian并在“第三方插件”中启用 Xiaohongshu Importer Plus。
### GitHub Release install/通过 GitHub Release 安装
1. Open the latest release in this repository.
2. Download the plugin assets or the bundled zip package.
3. Extract the files into `.obsidian/plugins/xhs-importer/`.
4. Reload Obsidian and enable the plugin.
## Configuration
1. 打开本仓库的最新 Release 页面。
2. 下载插件文件,或下载已打包好的 zip 文件。
3. 将文件解压到以下目录:`.obsidian/plugins/xhs-importer/`.
4. 重新加载 Obsidian并启用该插件。
## Configuration/插件配置
The plugin settings page includes:
@ -36,7 +55,15 @@ The plugin settings page includes:
- **Download images**: toggle local image downloads on or off
- **Frontmatter Fields**: add, remove, reorder, enable, or disable frontmatter fields
插件设置页包含以下选项:
* 默认笔记文件夹:导入后的 Markdown 笔记保存位置
* 默认图片文件夹:下载后的图片保存位置
* 下载图片:是否将图片下载到本地
* Frontmatter 字段:添加、删除、排序、启用或禁用 Frontmatter 字段
The default frontmatter preset includes:
默认 Frontmatter 预设如下:
```yaml
---
@ -49,19 +76,37 @@ tags:
---
```
## Usage
## Usage/使用方法
1. Click the ribbon icon or run the command `Import Xiaohongshu note`.
2. Paste a Xiaohongshu share text snippet or direct note URL.
3. Choose whether to download images locally for this import.
4. The plugin creates a note with frontmatter,正文内容, and media links in your configured folders.
## Known limitations
1. 点击侧边栏图标,或运行命令 Import Xiaohongshu note。
2. 粘贴小红书分享文本片段或直接笔记链接。
3. 选择本次导入是否下载图片到本地。
4. 插件会根据你的配置,在指定文件夹中创建一篇包含 Frontmatter、正文内容和媒体链接的笔记。
## Known limitations/已知限制
- Parsing depends on the current Xiaohongshu page structure and embedded page data.
- If Xiaohongshu changes its frontend structure, title, content, image, or video parsing may need updates.
- Video notes currently store only a remote video link and optional cover image.
## Acknowledgements
- 解析结果依赖小红书当前网页结构和页面内嵌数据。
- 如果小红书调整前端结构,标题、正文、图片或视频解析逻辑可能需要同步更新。
- 视频笔记目前仅保存远程视频链接,以及可选的封面图片。
## Acknowledgements/
This plugin is adapted from the original `xiaohongshu-importer` plugin by `bnchiang96`.
## Support the Author/支持作者
If this plugin saves you time or makes your Obsidian workflow smoother, you are welcome to support me with a cup of coffee.
如果这个插件帮你节省了时间,或者让你的 Obsidian 工作流更顺手,欢迎各位富哥随缘支持一下。
<img width="308" height="344" alt="support-author-wechat-alipay-bilingual-title" src="https://github.com/user-attachments/assets/8efa5e62-c6ef-43a6-84ed-3c3b3d07e22c" />