外观
研究与写作流程
打开笔记仓库
在 Obsidian 中选择「打开文件夹作为仓库」,打开整个 japan-stock 文件夹。
docs/ 中的 Markdown 会发布到网站;writing/ 用于模板、草稿和研究资料,不参与网站发布。新笔记默认放入 writing/drafts/,附件默认放入 docs/assets/。
docs/public/ 的所有文件都会复制到网站,docs/assets/ 中被页面引用的附件也会发布。未准备公开的原始资料请保存在 writing/research/。
创建公司笔记
从 writing/templates/company.md 复制初稿到 writing/drafts/,保留中文/日文公司名称和股票代码。这个模板用于快速记录;完整调研使用项目内 .agents/skills/japan-stock-researcher/ 中的 skill 和 references/report-template.md。
准备发布时将笔记移到 docs/companies/,填写 title、description 与 tags,并将股票代码保存为字符串 code。研究日期和来源应保留,未知信息留空,不填入假定的数据。新增、重命名笔记后运行 node scripts/build-directory.mjs,重新生成公司索引、上市公司名录与基金、文章索引,不要手工编辑这些生成页面;需要行业入口时再更新对应专题。
专题笔记放入 docs/topics/。引用写法见 双链使用指南。
检查与发布
在项目根目录运行:
sh
npm run docs:dev
npm run docs:build
npm run docs:preview构建会检查配置类型、必填元数据、双链目标和标题引用。VitePress 同时检查站内页面链接。未完成的笔记留在 writing/drafts/;设置 draft: true 不会使 VitePress 自动隐藏页面,本项目会阻止此类页面构建。
新增、删除、重命名笔记或修改别名后,重启开发服务以更新导航与双链索引。修改正文会自动刷新。
已迁入内容
~/Sync/wiki/japan-company/ 的 232 篇公司笔记,以及 Wiki 中其他目录里的公司报告、补充长文、基金笔记与专题,已复制到 docs/ 的相应目录,并以 wiki_source / wiki_sources 记录来源。Wiki 保持只读。原 Wiki 中目标已迁入的双链已恢复,其余保留为文字;若后来补建目标笔记,可重新加上双链。
项目已有的 scripts/sync-notes.mjs 与 scripts/sources.mjs 是早期同步草稿,不纳入日常命令。它们包含覆盖和清理生成页的行为,不要用于这个仓库。