使用 Next.js App Router 与 MDX 构建静态站点,部署在 Vercel
public-docs — Next.js 文档模板
作者 thinkyou0714
基于 Next.js App Router 与 MDX 的静态公开文档站点模板,用于发布模板实现指南,内容以 MDX 文件管理,部署在 Vercel。
看看你的网站会是什么样
浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。
全部页面与视图 3
截图用于了解视觉与布局,交互效果请以实际项目为准。
值得关注的模板亮点
从已有项目资料中,快速了解它的特点。
内容按 templates、guides、troubleshooting、changelog 四个分区组织为 MDX 文件
提供 docs/ 下的文章规范、DoD 10 项检查清单与机密检查流程
包含 scripts/check-secrets.sh 机密混入检测脚本,并接入 pre-commit hook 与 GitHub Actions
提供 obsidian-templates/ 填空模板与 template_id 编号规则
README 说明支持 Claude Code on the web,依赖由 .claude/bootstrap.sh 自动安装
模板详细介绍
public-docs 是一个公开文档站点模板,README 说明其使用 Next.js (App Router) 与 MDX 构建静态站点,部署在 Vercel,用于公开模板实现指南并提供可复现的操作步骤。内容存放于 content/ 目录,按 templates、guides、troubleshooting、changelog 四个分区组织,文章为 MDX 文件并带 frontmatter。仓库包含 docs/ 下的文章规范、DoD 检查清单与机密检查流程,以及 scripts/check-secrets.sh 机密检测脚本和 obsidian-templates/ 的 Obsidian 填空模板。README 强调仓库不包含 URL、企业/个人名称、数值、token 等机密信息,并给出文章新增、更新、DoD 检查与部署的操作步骤。模板分类包括 LINE、Obsidian、X、Ops,README 列出了 P0 文章清单及 template_id 编号规则。CI/CD 方面,README 描述本地 pre-commit hook 执行机密检查、GitHub Actions 在 push/PR 到 main 时执行机密检查、构建与 DoD,Vercel 在 main push 时自动部署。README 还说明该仓库支持 Claude Code on the web,依赖由 .claude/bootstrap.sh 自动安装,并提及模板是来自 private canonical 的构建时镜像,编辑应在源侧进行。README 未提供页面功能、性能或生产就绪程度的说明。
适合你的项目吗?
适用场景
- 发布模板实现指南并让读者按步骤复现
- 按文章规范新增或更新 MDX 文档并执行 DoD 检查
- 在提交与 CI 阶段运行机密检查脚本,避免机密信息进入仓库
- 使用 Obsidian 模板整理内容并映射到 content/ 目录
- 在 Vercel 上自动部署静态文档站点
适合人群
- 需要公开模板实现指南的文档维护者
- 使用 Next.js 与 MDX 管理静态文档内容的团队
- 需要将机密检查纳入提交与 CI 流程的项目
- 使用 Obsidian 进行知识管理并发布公开文档的用户
上手与定制指南
结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。
- 1
README 提供的本地命令:npm install、npm run dev、npm run check-secrets、npm run build
- 2
部署方式:main 分支 push 后由 Vercel 自动部署
- 3
新增文章需先查看 docs/article-spec.md,复制 obsidian-templates/TEMPLATE-GUIDE.md 填写,并按规则分配 template_id
- 4
更新文章需递增 version、更新 last_verified_yyyy_mm 并在变更历史中追加差异
- 5
README 说明该仓库支持 Claude Code on the web,依赖由 .claude/bootstrap.sh 自动安装
授权与来源资料
使用条件与限制
免费使用 · 保留许可声明本次收录的是公开仓库中采用 MIT 许可的免费版本;免费范围为该版本代码,不代表外部服务或第三方素材免费。
使用时需要遵守
- 允许免费使用、修改、商用和分发该版本代码。
- 分发代码副本或实质性部分时,保留原作者版权声明和完整 MIT 许可声明。
- 代码按现状提供;担保与责任限制以原许可证及适用法律为准。
额外费用与待核对事项
- 演示图片、字体、图标及其他第三方素材需按各自许可核对,不能仅凭代码的 MIT 许可判断。
- 域名、托管、数据库、支付或 AI 等外部服务可能另外收费。
- 模板 JSON 本体、会员向详细内容与 sanitized 运用 Tips 位于另一个非公开仓库 private-members,本仓库不包含这些内容。
- 模板内容来自 private canonical 仓库的构建时镜像,编辑应在源仓库侧进行,而非本仓库。
- MCP 在本仓库中仅限本地使用,不提供远程/云端 MCP 支持。
- /00_raw_private 目录允许存放机密数据,但禁止用于 NotebookLM。
- /10_sanitized 目录要求机密为零,且禁止存放机密信息。
- /20_publish 目录用于站点公开,要求机密为零,且禁止存放机密信息。
- 仓库不得包含 URL、企业/个人名称、数值、token 等机密信息。
查看原文依据
Permission is hereby granted, free of charge
许可证原文
- **private-members** — テンプレJSON本体、会員向け詳細、sanitized運用Tips(別リポジトリ・非公開)
README 原文
- テンプレートは private canonical からの build-time ミラー。編集は source 側で。
README 原文
- MCP は本リポジトリではローカル専用。詳細は
README 原文
| `/00_raw_private` | 生データ、機密OK | OK | **禁止** |
README 原文
| `/10_sanitized` | 顧客送付用、機密ゼロ | **禁止** | OK |
README 原文
| `/20_publish` | サイト公開用、機密ゼロ | **禁止** | OK |
README 原文
https://github.com/thinkyou0714/public-docs/blob/main/LICENSEhttps://github.com/thinkyou0714/public-docs/blob/main/README.md**機密ポリシー**: このリポジトリには URL、企業名/個人名、数値、トークン等の機密情報を **一切含めない**。
README 原文
DeepSeek 根据仓库许可证和 README 整理 ·2026-10-14。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。
项目核对记录与介绍依据
模板资料
- 来源平台
- GitHub
- 资料与维护参考分
- 资料较完整 · 80 / 100
- 技术栈
- Next.js · React
- 网站类型
- 文档
这个分数如何计算
本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。
这个项目需要核对什么
- 记录的仓库更新时间
- 2026-10-03
- 截图检查日期
- 2026-10-14
已收录演示链接。请用你的内容与屏幕尺寸检查;有演示不代表表单、认证或支付已经可用。
目录记录的主要技术栈是 Next.js。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。
查看具体选型方法 →介绍的制作与核对状态
介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。
审核声明: codex-user-requested-batch-review-20261015 · 2026-10-15
查看当时使用的来源资料
SHA-256: 60986cb6c14642993613b164895c012bb3f1e3fb8a859dbfa5a40f623e1a37ce
2026-10-14T17:01:57.903Z
来源文件 / 仓库# public-docs
Template Implementation Guides — 公開ドキュメントサイト
**本番サイト**: https://public-docs-phi.vercel.app
## 概要
Next.js (App Router) + MDX で構築された静的サイト。Vercel でデプロイ。
テンプレート実装ガイドを公開し、誰でも再現可能な手順を提供する。
**機密ポリシー**: このリポジトリには URL、企業名/個人名、数値、トークン等の機密情報を **一切含めない**。
## Tech Stack
- Next.js 15 (App Router, Static Export)
- MDX (gray-matter + next-mdx-remote)
- Tailwind CSS 3
- Vercel (デプロイ先)
## ディレクトリ構成
```
public-docs/
├── content/ # MDXコンテンツ(記事本体)
│ ├── templates/ # テンプレ実装ガイド
│ ├── guides/ # 共通ガイド
│ ├── troubleshooting/ # 症状記事
│ └── changelog/ # 更新履歴
├── src/
│ ├── app/ # Next.js App Router
│ ├── lib/ # コンテンツローダー等
│ └── components/ # UIコンポーネント
├── docs/ # 運用ドキュメント
│ ├── article-spec.md # 記事規格
│ ├── dod-checklist.md # DoD 10項目
│ └── security-checklist.md # 機密チェック手順
├── scripts/
│ └── check-secrets.sh # 機密混入検出スクリプト
└── obsidian-templates/ # Obsidian穴埋めテンプレート
```
## カテゴリ
| カテゴリ | 説明 |
|---------|------|
| LINE | LINE関連の自動化テンプレート |
| Obsidian | ナレッジ管理テンプレート |
| X | X(Twitter)連携テンプレート |
| Ops | 運用自動化テンプレート |
## 運用手順
### 記事の追加
1. `docs/article-spec.md` で記事規格を確認
2. `obsidian-templates/TEMPLATE-GUIDE.md` をコピーして穴埋め
3. template_id を採番(例: `TMPL-LINE-002`)
4. `content/{section}/{slug}.mdx` として配置
5. frontmatter の全必須フィールドを記入
### 記事の更新
1. 該当 `.mdx` ファイルを編集
2. `version` をインクリメント
3. `last_verified_yyyy_mm` を更新
4. 「変更履歴」セクションに差分を追記
### DoD チェック(公開前必須)
1. `docs/dod-checklist.md` の10項目を自己チェック
2. 機密チェックスクリプトを実行:
```bash
npm run check-secrets
# または
bash scripts/check-secrets.sh
```
3. 全項目OKを確認してからコミット・デプロイ
### デプロイ
```bash
# ローカル確認
npm run dev
# ビルド(静的出力)
npm run build
# Vercel(mainブランチへのpushで自動デプロイ)
git push origin main
```
## template_id 採番規則
| セクション | フォーマット | 例 |
|-----------|------------|-----|
| templates | `TMPL-{CATEGORY}-{NNN}` | TMPL-LINE-001 |
| troubleshooting | `TS-{CATEGORY}-{NNN}` | TS-LINE-001 |
| guides | `GUIDE-{NNN}` | GUIDE-001 |
| changelog | `CL-{YYYY-MM}` | CL-2026-02 |
## P0 記事一覧
| template_id | カテゴリ | セクション | タイトル |
|-------------|---------|----------|---------|
| TMPL-LINE-001 | LINE | templates | LINE公式アカウント自動応答テンプレート |
| TMPL-OBS-001 | Obsidian | templates | Obsidianナレッジベース自動整理テンプレート |
| TMPL-X-001 | X | templates | X(Twitter)投稿自動化テンプレート |
| TMPL-OPS-001 | Ops | templates | 定期レポート自動生成テンプレート |
| TS-LINE-001 | LINE | troubleshooting | LINE Webhook が応答しない |
## Obsidian連携
Obsidian Vault での運用フォルダ:
| フォルダ | 用途 | 機密 | NotebookLM |
|---------|------|------|-----------|
| `/00_raw_private` | 生データ、機密OK | OK | **禁止** |
| `/10_sanitized` | 顧客送付用、機密ゼロ | **禁止** | OK |
| `/20_publish` | サイト公開用、機密ゼロ | **禁止** | OK |
## CI/CD
| ステージ | ツール | トリガー |
|---------|-------|---------|
| ローカル機密チェック | pre-commit hook (`check-secrets.mjs`) | `git commit` |
| CI(機密+ビルド+DoD) | GitHub Actions | push / PR to main |
| デプロイ | Vercel | main push(自動) |
```bash
# セットアップ(hook自動インストール含む)
npm install
# ローカル開発
npm run dev
# 機密チェック
npm run check-secrets
# ビルド(sitemap自動生成 + 静的出力)
npm run build
```
## 関連リポジトリ
- **private-members** — テンプレJSON本体、会員向け詳細、sanitized運用Tips(別リポジトリ・非公開)
## Claude Code で開発する (web / cloud 対応)
このリポジトリは **Claude Code on the web** に対応しています。
- 依存は `.claude/bootstrap.sh`(SessionStart)が `npm ci` で自動インストール。
- クラウドセッションは `AGENTS.md` と `.claude/skills/`(例: `build-site`)を自動ロード。
- テンプレートは private canonical からの build-time ミラー。編集は source 側で。
- MCP は本リポジトリではローカル専用。詳細は
[`.github/docs/claude-code-web-readiness.md`](https://github.com/thinkyou0714/.github/blob/main/docs/claude-code-web-readiness.md)。
看看同类模板
对比同技术栈与用途的模板,找到更适合的视觉与内容结构。

nextjs-prisma-boilerplate
nemanjam/nextjs-prisma-boilerplate 是一个面向中小型全栈应用的生产级启动器,围绕 Next.js 12、React 18、Prisma 4 和 Postgres 构建。
Next.js · 文档

rubix-documents
Documents is a powerful and flexible Next.js documentation starter kit designed to simplify the process of cre…
Next.js · 文档

lil-docs-template
A lil docs template for lil projects.
Next.js · 文档

next-app-nextra-template
Template for Next.js 16 app router + Mantine 9 UI + Nextra 4
Next.js · 文档

docs-template
Fully featured documentation website, powered by Next.js, Radix Themes, and BaseHub.
Next.js · 文档

shadcn-blog
A blog template built using Next.JS 15, shadcn/ui, and fumadocs.
Next.js · 博客
