README file from
GithubXiaohongshu Importer Plus
An Obsidian plugin for importing Xiaohongshu (小红书) notes into your vault with configurable default folders, configurable frontmatter fields, local image downloads, and video links.
Features
- Import Xiaohongshu share text or note URLs directly into Obsidian
- Configure default note and image folders in plugin settings
- Configure frontmatter fields with editable order, enable state, and default values
- Support frontmatter placeholders:
{{date}},{{title}},{{source}},{{videoUrl}} - 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
Manual install
- Download
main.js,manifest.json, andstyles.cssfrom the latest GitHub Release. - Create a folder named
xhs-importerunder your vault's.obsidian/plugins/. - Copy the three files into that folder.
- Reload Obsidian and enable Xiaohongshu Importer Plus in Community Plugins.
GitHub Release install
- Open the latest release in this repository.
- Download the plugin assets or the bundled zip package.
- Extract the files into
.obsidian/plugins/xhs-importer/. - Reload Obsidian and enable the plugin.
Configuration
The plugin settings page includes:
- Default note folder: where imported Markdown notes are created
- Default image folder: where downloaded images are saved
- Download images: toggle local image downloads on or off
- Frontmatter Fields: add, remove, reorder, enable, or disable frontmatter fields
The default frontmatter preset includes:
---
aliases:
created: {{date}}
tags:
- 类型/摘录
- 状态/待加工
上级概念:
---
Usage
- Click the ribbon icon or run the command
Import Xiaohongshu note. - Paste a Xiaohongshu share text snippet or direct note URL.
- Choose whether to download images locally for this import.
- The plugin creates a note with frontmatter,正文内容, and media links in your configured folders.
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
This plugin is adapted from the original xiaohongshu-importer plugin by bnchiang96.