vibe-study-skills

内容来源：README.md（说明文档） · 原始地址 · 查看安装指南

原始内容

# 📚 Obsidian Notes Creator

An AI skill for creating high-quality Obsidian study notes — with rich analogies, diagrams, and structured explanations that genuinely teach.

---

## What It Does

The `obsidian-notes-creator` skill transforms source material (lecture slides, PDFs, textbooks, rough notes) into polished Obsidian markdown. It knows how to:

- Write **intuition-first** — motivation and analogy before formula
- Apply **5 analogy patterns** (step-down, before/after contrast, object, pseudocode, direction-flip)
- Choose the right **Mermaid diagram type** for each situation
- Use **Obsidian callouts** purposefully (not decoratively)
- Scale from a **single note** to a **multi-file topic set** with an index hub

---

## See It In Action

Real notes produced by the skill, showing its three visual styles:

**Embedded SVG — data figures** (a correlation-regime heatmap)

![Correlation heatmap study note with an embedded SVG](https://github.com/szeyu/vibe-study-skills/raw/HEAD/assets/example-svg-heatmap.webp)

**Mermaid — processes & cycles** (the CBR 4R model)

![Study note with a Mermaid cycle diagram](https://github.com/szeyu/vibe-study-skills/raw/HEAD/assets/example-mermaid-cycle.webp)

**ASCII + callouts — side-by-side contrast** (DFT vs DCT)

![Study note with an ASCII side-by-side diagram and a callout](https://github.com/szeyu/vibe-study-skills/raw/HEAD/assets/example-ascii-compare.webp)

---

## Installation

```bash
npx skills add https://github.com/szeyu/vibe-study-skills
```

---

## Usage

Just describe what you need:

- *"Create study notes from this lecture on contrastive learning"*
- *"Turn these rough notes on MoCo into an Obsidian note with analogies"*
- *"Organise my ML notes into a multi-file structure"*
- *"Generate a note for self-supervised learning with diagrams and examples"*

---

## Skill Structure

```
skills/obsidian-notes-creator/
├── SKILL.md
└── references/
    ├── components/         ← Obsidian syntax (callouts, diagrams, frontmatter, wikilinks)
    ├── writing/            ← How to write content that teaches (analogies, examples, comparisons)
    ├── structure/          ← When to split into multiple files, templates
    └── quality-checklist.md
```

---

## License

MIT — see [LICENSE](https://github.com/szeyu/vibe-study-skills/tree/HEAD/LICENSE)

📚 Obsidian Notes Creator

An AI skill for creating high-quality Obsidian study notes — with rich analogies, diagrams, and structured explanations that genuinely teach.

What It Does

The obsidian-notes-creator skill transforms source material (lecture slides, PDFs, textbooks, rough notes) into polished Obsidian markdown. It knows how to:

Write intuition-first — motivation and analogy before formula
Apply 5 analogy patterns (step-down, before/after contrast, object, pseudocode, direction-flip)
Choose the right Mermaid diagram type for each situation
Use Obsidian callouts purposefully (not decoratively)
Scale from a single note to a multi-file topic set with an index hub

See It In Action

Real notes produced by the skill, showing its three visual styles:

Embedded SVG — data figures (a correlation-regime heatmap)

Correlation heatmap study note with an embedded SVG

Mermaid — processes & cycles (the CBR 4R model)

Study note with a Mermaid cycle diagram

ASCII + callouts — side-by-side contrast (DFT vs DCT)

Study note with an ASCII side-by-side diagram and a callout

Installation

npx skills add https://github.com/szeyu/vibe-study-skills

Usage

Just describe what you need:

"Create study notes from this lecture on contrastive learning"
"Turn these rough notes on MoCo into an Obsidian note with analogies"
"Organise my ML notes into a multi-file structure"
"Generate a note for self-supervised learning with diagrams and examples"

Skill Structure

skills/obsidian-notes-creator/
├── SKILL.md
└── references/
    ├── components/         ← Obsidian syntax (callouts, diagrams, frontmatter, wikilinks)
    ├── writing/            ← How to write content that teaches (analogies, examples, comparisons)
    ├── structure/          ← When to split into multiple files, templates
    └── quality-checklist.md

License

MIT — see LICENSE