跳轉到

檔案結構

摘要

本頁說明 AI知識庫 repository 的主要檔案與資料夾用途。

主要結構

.
├── docs/                  # 公開網站內容
├── mkdocs.yml             # MkDocs 設定與導覽
├── README.md              # 專案說明
├── AGENTS.md              # Codex 與 AI agent 維護規則
├── CONFIDENTIALITY.md     # 保密協定草稿
├── CONTRIBUTING.md        # 貢獻指南
├── SECURITY.md            # 敏感資料外洩處理
├── .antigravity/rules.md  # AntiGravity IDE 規則
└── .github/               # GitHub workflow 與 PR template

docs/ 內容

docs/ 是正式公開內容區。新增到此資料夾的 Markdown 可能被發布到網站。

常見分類：

  • getting-started/
  • ai-tools/
  • prompt-engineering/
  • workflows/
  • research-writing/
  • teaching/
  • policies/
  • reference/

不應提交的內容

  • .env
  • .venv/
  • .wrangler/
  • site/
  • private/
  • drafts/
  • secrets/
  • credentials 或 key 檔

注意事項

即使 repository 是 private，也不應提交 API keys、tokens、passwords 或 private keys。

相關頁面

更新紀錄

  • 2026-07-02：建立初始版本。