@qnroa/qtype 0.0.1 → 0.0.3

package/docs/zh/getting-started.md

@@ -0,0 +1,104 @@
+# 5 分钟入门
+
+English: [getting-started.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/en/getting-started.md)
+
+## 0. 准备
+
+- Node ≥ 20
+- 一个终端
+
+## 1. 创建仓库
+
+```bash
+mkdir my-deck
+npx @qnroa/qtype init my-deck --lang zh
+cd my-deck
+```
+
+`qtype init` 会往 `my-deck/` 里塞:
+
+- `QTYPE.md` —— 写卡片的规范(给你自己 + 给 LLM 看)
+- `material/word.md`, `sentence.md`, `article.md`, `snippet.md`, `qa.md`, `code.md` —— 6 张类型模板,每张都是能直接跑起来的示例
+- `material/assets/<type>/*.svg` —— 模板引用的 SVG 图片
+- `README.md`, `TODO.md`, `index.md`, `log.md` —— 空壳,可以随便写
+- `.qtype/config.json` —— 仓库配置
+
+**关键点**:一个 `.md` 文件 = 一副卡组,整个文件一个 `type`。
+
+## 2. 打开一张模板卡试改
+
+`material/sentence.md` 长这样:
+
+```markdown
+---
+title: 句子示例
+type: sentence
+tags: [示例, 句子]
+---
+
+# The quick brown fox jumps over the lazy dog.
+## /ðə kwɪk braʊn fɑks/
+### 敏捷的棕色狐狸跳过懒狗——英文全字母句。
+#### ![A-Z](./assets/sentence/pangram.svg)
+
+# 熟能生巧。
+## /shú néng shēng qiǎo/
+### Practice makes perfect.
+```
+
+- **H1(`#`)= 打字目标**(你要敲的东西)
+- H2 音标 / H3 翻译 / H4 图片 是可选的展示位
+
+每个类型的格式都不一样,详细见 [material-types.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/material-types.md);
+快速对照见 [authoring.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/authoring.md)。
+
+## 3. 校验
+
+```bash
+npx @qnroa/qtype check
+```
+
+只读的 lint 检查:找出无法打字的字符(比如 emoji / 零宽字符)。**退出码 0 = 通过**。
+
+## 4. 构建 + 预览
+
+```bash
+npx @qnroa/qtype publish build      # 生成 dist/
+npx @qnroa/qtype publish serve      # 起 :4000
+```
+
+浏览器打开 http://localhost:4000。你会看到 6 张 material,点进去开始打字。
+
+## 5. 部署到线上
+
+最快的方式是 GitHub Pages:
+
+```bash
+npx @qnroa/qtype publish init --ci github
+git init && git add . && git commit -m "init"
+git remote add origin https://github.com/YOUR_NAME/my-deck.git
+git push -u origin main
+```
+
+在仓库 Settings → Pages 里 Source 选 **GitHub Actions**。等 workflow 跑完就上线。
+
+其他平台(Cloudflare / Vercel / Netlify / nginx)见 [deployment.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/deployment.md)。
+
+## 6. 想加密?
+
+```bash
+npx @qnroa/qtype publish password set
+# 交互输入密码
+
+npx @qnroa/qtype publish build
+```
+
+站点会跳一个密码框才让进,内容 AES-256-GCM 加密。
+
+## 下一步
+
+- 想加更多卡组 → 复制某个类型模板重命名即可
+- 想让 LLM 帮你写材料 → 读 `QTYPE.md`,把它扔给 Claude / Copilot 说「按这个规范帮我做一副 GRE 词汇卡」
+- 想调打字体验 → 界面右下角齿轮打开设置,或 [settings.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/settings.md)
+- 想调打字规则(严格 / 宽松 / 大小写不敏感) → [typing-rules.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/typing-rules.md)
+- 快捷键 → [shortcuts.md](https://www.npmjs.com/package/@qnroa/qtype?activeTab=code&filepath=docs/zh/shortcuts.md)