Hướng dẫn phát triển plugin Obsidian
Bộ quy tắc toàn diện cho việc phát triển plugin Obsidian: ESLint, API, khả năng truy cập và quy trình nộp lên cộng đồng.
Lập trìnhTrung cấp★ 182⑂ 15Điểm AI 9/10Cập nhật lần cuối: 8 thg 8, 2026
Làm được gì
- Tóm gọn hơn 40 quy tắc của
eslint-plugin-obsidianmdv0.4.1 thành bảng ✅/❌ để áp dụng ngay khi viết hoặc review code. - Chỉ ra các lỗi thường gặp: quản lý bộ nhớ (
registerEvent,registerDomEvent), an toàn kiểu (instanceofthay vì cast), chọn API Vault/Editor (Vault.processthaymodify), mạng (requestUrlthayfetch), tương thích cửa sổ popout (activeDocument/activeWindow). - Hướng dẫn di trú sang Settings khai báo (
getSettingDefinitions()) của Obsidian 1.13+, dùng biến CSS theo theme, và danh sách bắt buộc về accessibility (bàn phím, ARIA, focus, vùng cảm ứng ≥ 44×44px). - Cung cấp quy trình 7 bước nộp plugin lên community.obsidian.md, mẹo tối ưu Scorecard (mục tiêu 90%+), cùng các tài liệu chi tiết trong
reference/và trình tạo khung dự ántools/create-plugin.js.
Phù hợp với ai
- Lập trình viên lần đầu viết plugin Obsidian hoặc đang chuẩn bị nộp lên community.obsidian.md.
- Người muốn dọn hết cảnh báo ESLint và nâng điểm Scorecard cho plugin đã phát hành.
- Dev TypeScript cần đảm bảo plugin chạy tốt trên mobile và cửa sổ popout.
Ví dụ sử dụng
- "Tôi muốn tạo plugin Obsidian mới" → gợi ý dùng trình tạo boilerplate rồi kiểm tra quy tắc đặt tên trong
manifest.json. - Dán
main.tsvà yêu cầu review → phát hiện rò rỉaddEventListener, dùngfetch(), chuỗi UI viết Title Case, code mẫu chưa xóa. - "Cần kiểm gì trước khi submit?" → chạy ESLint, xác thực manifest/LICENSE, test mobile, audit bàn phím, tạo GitHub Release rồi nộp.
· · · Hướng dẫn cài đặt · · ·
Dùng thử ngay, không cần cài
Dán đoạn dưới vào Claude là dùng được skill này mà không cần cài đặt.
Hãy đọc hướng dẫn trong tệp này và làm theo để giúp mình: https://raw.githubusercontent.com/gapmiss/obsidian-plugin-skill/HEAD/.agents/skills/obsidian/SKILL.md Mình muốn: (viết việc bạn cần ở đây)
Nếu Claude không mở được liên kết, hãy mở liên kết và copy nội dung vào rồi dán.
↓ Thấy hữu ích thì tải ZIP bên dưới và cài. Sau đó skill tự chạy, không phải dán lại mỗi lần.
Cài vào ứng dụng Claude (không cần terminal)
- Tải tệp ZIP bằng nút bên dưới.
- Trong Claude, mở Settings → Capabilities và bật 'Code execution and file creation'. (chỉ một lần)
- Vào Customize → Skills → + → 'Upload a skill' rồi tải tệp ZIP lên.
Cài vào Claude Code
Để Claude làm — dán câu dưới đây vào Claude Code
Hãy cài skill mình tìm thấy trên Claude Skill Mart. Copy thư mục .agents/skills/obsidian từ repo GitHub gapmiss/obsidian-plugin-skill vào ~/.claude/skills/obsidian/ của mình. Sau khi cài xong, cho mình biết skill này làm được gì trong một câu.
Cài bằng lệnh thủ công
git clone https://github.com/gapmiss/obsidian-plugin-skill.git /tmp/obsidian-plugin-skill && mkdir -p ~/.claude/skills && cp -r /tmp/obsidian-plugin-skill/.agents/skills/obsidian ~/.claude/skills/obsidian⚠ Đây là skill do người khác tạo. Hãy kiểm tra repo gốc trước khi cài.
- Mở terminal.
- Tải repo skill:
git clone https://github.com/gapmiss/obsidian-plugin-skill.git /tmp/obsidian-plugin-skill - Tạo thư mục skills nếu chưa có:
mkdir -p ~/.claude/skills - Sao chép skill:
cp -r /tmp/obsidian-plugin-skill/.agents/skills/obsidian ~/.claude/skills/obsidian - Kiểm tra đã có thư mục
reference/vàtools/:ls ~/.claude/skills/obsidian - Khởi động lại Claude Code và thử: "Review file main.ts của plugin Obsidian của tôi" — skill sẽ tự kích hoạt.
Xem mã nguồn trên GitHub ↗Giấy phép: MIT