Skip to content

Commit 4dfe678

Browse files
author
ZhongJiaqi
committed
docs: add workflow diagram and CI syntax check
- README: mermaid flowchart at top showing 微信读书 → CLI → Obsidian vault → Bases 视图 - CI: GitHub Actions runs python3 -m py_compile on push/PR to catch syntax errors
1 parent e167db2 commit 4dfe678

2 files changed

Lines changed: 35 additions & 0 deletions

File tree

.github/workflows/syntax-check.yml

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: Syntax Check
2+
3+
on:
4+
push:
5+
branches: [main]
6+
pull_request:
7+
branches: [main]
8+
9+
jobs:
10+
py-compile:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: actions/checkout@v4
14+
- name: Set up Python
15+
uses: actions/setup-python@v5
16+
with:
17+
python-version: '3.11'
18+
- name: Compile check
19+
run: python3 -m py_compile weread-to-obsidian

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,22 @@
22

33
> 把微信读书的划线和想法自动整理成 Obsidian 笔记。让你"翻阅过的痕迹"从 App 里解放出来,变成可整理、可重读、可二次加工的素材。
44
5+
## 工作流一览
6+
7+
```mermaid
8+
flowchart LR
9+
A["📱 微信读书<br/>划线 · 想法"]
10+
B["⚙️ weread-to-obsidian<br/>Python CLI · stdlib only"]
11+
C["📖 单本笔记<br/>按章节 · YAML frontmatter<br/>weread:// 深链回 App"]
12+
D["🗂️ Obsidian Bases 视图<br/>表格 · 时间线 · 卡片墙"]
13+
14+
A -->|"Agent API Gateway"| B
15+
B -->|"输出 Markdown"| C
16+
C -.->|"frontmatter 字段"| D
17+
```
18+
19+
一条命令把笔记从微信读书拉到本地 Obsidian vault,并通过 `.base` 视图聚合浏览。
20+
521
## 它做什么
622

723
一条命令,把你在微信读书的笔记(划线 + 想法/批注)按章节结构化输出成 Markdown,落到 Obsidian vault 里。

0 commit comments

Comments
 (0)