readme and previews

This commit is contained in:
WesternGua 2026-05-03 13:19:22 +08:00
parent 11cc0407dd
commit 8b7d1cb58d
3 changed files with 0 additions and 44 deletions

View file

@ -47,28 +47,6 @@
---
## 仓库结构
- `src/` — TypeScript 源码
- `assets/screenshots/` — README 截图资源
- `docs/` — 开发与维护文档
- `manifest.json` — Obsidian 插件清单
- `versions.json` — 版本与最低 Obsidian 兼容版本映射
- `main.js` — 构建产物本目录作为实际插件目录时Obsidian 直接加载它
- `data.json` — 本地插件数据,不应纳入版本控制
---
## GitHub 仓库建议
如果后续把这个目录单独初始化为 GitHub 仓库,推荐保留当前布局,并:
- 提交 `src/`、`manifest.json`、`versions.json`、`README*`、`CHANGELOG.md`
- 忽略 `node_modules/`、`data.json`、`.DS_Store`
- 通过 GitHub Actions 或本地 `npm run check && npm run build` 做构建验证
---
## 快速上手
### 1. 插入引用

View file

@ -45,28 +45,6 @@ This version has been developed and tested primarily on **macOS**. Linux and Win
---
## Repository Layout
- `src/` — TypeScript source
- `assets/screenshots/` — README image assets
- `docs/` — development and maintenance docs
- `manifest.json` — Obsidian plugin manifest
- `versions.json` — compatibility map from plugin version to minimum Obsidian version
- `main.js` — build artifact; Obsidian loads this directly when this folder is used as the live plugin directory
- `data.json` — local plugin data and should not be version-controlled
---
## GitHub Repo Notes
If you later split this directory into its own GitHub repository, this layout can stay as-is. A typical setup is:
- commit `src/`, `manifest.json`, `versions.json`, `README*`, and `CHANGELOG.md`
- ignore `node_modules/`, `data.json`, and `.DS_Store`
- validate with GitHub Actions or local `npm run check && npm run build`
---
## Quick Start
### 1. Insert a Citation

Binary file not shown.

After

Width:  |  Height:  |  Size: 564 KiB