create-cocowiki 0.2.2

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mueo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,14 @@
+# create-cocowiki
+
+创建一个带有完整示例内容的 CoCoWiki 静态 Wiki 项目。
+
+```bash
+pnpm create cocowiki my-wiki
+cd my-wiki
+pnpm install
+pnpm dev
+```
+
+生成的站点名称、npm 包名和首页名称会自动使用目标目录名 `my-wiki`。
+
+项目主页与完整说明位于 [CoCoWiki 源码仓库](https://github.com/coconi-dev/cocowiki)。

package/bin/create-cocowiki.mjs

@@ -0,0 +1,41 @@
+#!/usr/bin/env node
+import { cp, mkdir, readFile, readdir, rename, writeFile } from 'node:fs/promises'
+import { basename, resolve } from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+const targetArgument = process.argv.slice(2).find((argument) => !argument.startsWith('-')) || 'cocowiki-site'
+const targetDirectory = resolve(process.cwd(), targetArgument)
+const templateDirectory = fileURLToPath(new URL('../template', import.meta.url))
+const siteName = basename(targetDirectory)
+
+function fail(message) {
+  console.error(`\ncreate-cocowiki: ${message}\n`)
+  process.exit(1)
+}
+
+try {
+  await mkdir(targetDirectory, { recursive: true })
+  const existing = await readdir(targetDirectory)
+  if (existing.length) fail(`目标目录不为空：${targetDirectory}`)
+
+  await cp(templateDirectory, targetDirectory, { recursive: true })
+  await rename(resolve(targetDirectory, '_gitignore'), resolve(targetDirectory, '.gitignore'))
+
+  const packageFile = resolve(targetDirectory, 'package.json')
+  const packageJson = JSON.parse(await readFile(packageFile, 'utf8'))
+  packageJson.name = siteName.toLocaleLowerCase().replace(/[^a-z0-9._-]+/g, '-') || 'cocowiki-site'
+  await writeFile(packageFile, `${JSON.stringify(packageJson, null, 2)}\n`)
+
+  for (const relativeFile of ['cocowiki.config.ts', 'content/index.md']) {
+    const filename = resolve(targetDirectory, relativeFile)
+    const source = await readFile(filename, 'utf8')
+    await writeFile(filename, source.replaceAll('__COCOWIKI_SITE_NAME__', siteName))
+  }
+
+  console.log(`\nCoCoWiki 已创建：${targetDirectory}\n`)
+  console.log(`  cd ${targetArgument}`)
+  console.log('  pnpm install')
+  console.log('  pnpm dev\n')
+} catch (error) {
+  fail(error instanceof Error ? error.message : String(error))
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "create-cocowiki",
+  "version": "0.2.2",
+  "type": "module",
+  "description": "Create a CoCoWiki site.",
+  "author": "Mueo",
+  "license": "MIT",
+  "homepage": "https://github.com/coconi-dev/cocowiki#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coconi-dev/cocowiki.git",
+    "directory": "packages/create-cocowiki"
+  },
+  "bugs": {
+    "url": "https://github.com/coconi-dev/cocowiki/issues"
+  },
+  "keywords": [
+    "cocowiki",
+    "wiki",
+    "vitepress",
+    "scaffold"
+  ],
+  "bin": {
+    "create-cocowiki": "./bin/create-cocowiki.mjs"
+  },
+  "files": [
+    "bin",
+    "template"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  }
+}

package/template/_gitignore

@@ -0,0 +1,3 @@
+.cocowiki/
+dist/
+node_modules/

package/template/cocowiki.config.ts

@@ -0,0 +1,37 @@
+import { defineCocoWikiConfig } from 'cocowiki'
+
+export default defineCocoWikiConfig({
+  title: '__COCOWIKI_SITE_NAME__',
+  description: '一个由 Markdown、Vue 和静态数据组成的轻量资料站示例。',
+  lang: 'zh-CN',
+  // 部署到子目录时可改为 '/my-wiki/'，根目录部署保持 '/'。
+  base: '/',
+  logo: '/cocowiki-logo.png',
+  favicon: '/favicon.png',
+  navigation: [
+    { text: '首页', link: '/' },
+    { text: '欢迎使用 CoCoWiki', link: '/welcome' },
+    {
+      text: '探索',
+      link: '/atlas',
+      items: [
+        { text: '组件图鉴', link: '/atlas' },
+        { text: '归档索引', link: '/archive' },
+        { text: '贡献者', link: '/contributors' }
+      ]
+    }
+  ],
+  home: {
+    visual: {
+      image: '/cocowiki-logo.png',
+      labels: ['Markdown', 'Vue', 'Search', 'Static', 'Theme', 'Archive']
+    }
+  },
+  search: { enabled: true },
+  markdown: { spoiler: true, wikiLink: true },
+  content: {
+    outline: true,
+    showPrevNext: true,
+    showLastUpdated: true
+  }
+})

package/template/components/ItemAtlas.vue

@@ -0,0 +1,81 @@
+<script setup lang="ts">
+import { computed, ref } from 'vue'
+import items from '../data/items.json'
+
+const query = ref('')
+const rarity = ref('all')
+const category = ref('all')
+const sort = ref('rarity')
+const rarityRank: Record<string, number> = { core: 3, stable: 2, extended: 1 }
+const rarityLabel: Record<string, string> = { core: '核心', stable: '稳定', extended: '扩展' }
+const categoryLabel: Record<string, string> = { data: '数据层', logic: '逻辑层', interface: '交互层' }
+const rarities = ['core', 'stable', 'extended']
+const categories = [...new Set(items.map((item) => item.category))]
+const filtered = computed(() => items
+  .filter((item) => !query.value || `${item.name} ${item.description}`.toLocaleLowerCase().includes(query.value.toLocaleLowerCase()))
+  .filter((item) => rarity.value === 'all' || item.rarity === rarity.value)
+  .filter((item) => category.value === 'all' || item.category === category.value)
+  .sort((a, b) => sort.value === 'name' ? a.name.localeCompare(b.name, 'zh-CN') : rarityRank[b.rarity] - rarityRank[a.rarity]))
+const allContributors = [...new Set(items.flatMap((item) => item.contributors))]
+</script>
+
+<template>
+  <div class="atlas">
+    <header class="atlas-header">
+      <div><p class="cw-kicker">VUE PAGE EXAMPLE</p><h1>组件图鉴</h1><p>这是一个由静态 JSON 驱动的纯 Vue 页面，用来验证搜索、筛选与排序。</p></div>
+      <strong>{{ filtered.length }} <small>项</small></strong>
+    </header>
+
+    <section class="atlas-toolbar" aria-label="图鉴筛选">
+      <label class="atlas-search"><span>⌕</span><input v-model="query" type="search" placeholder="搜索组件"></label>
+      <label><span>状态</span><select v-model="rarity"><option value="all">全部</option><option v-for="name in rarities" :key="name" :value="name">{{ rarityLabel[name] }}</option></select></label>
+      <label><span>层级</span><select v-model="category"><option value="all">全部</option><option v-for="name in categories" :key="name" :value="name">{{ categoryLabel[name] }}</option></select></label>
+      <label><span>排序</span><select v-model="sort"><option value="rarity">状态</option><option value="name">名称</option></select></label>
+    </section>
+
+    <section class="atlas-grid">
+      <article v-for="(item, index) in filtered" :key="item.id" class="atlas-card">
+        <span class="atlas-card__index">{{ String(index + 1).padStart(2, '0') }}</span>
+        <div class="atlas-card__content">
+          <div class="atlas-card__meta"><span>{{ categoryLabel[item.category] }}</span><b>{{ rarityLabel[item.rarity] }}</b></div>
+          <h2>{{ item.name }}</h2>
+          <p>{{ item.description }}</p>
+          <footer><span>维护者</span><strong>{{ item.contributors.join(' · ') }}</strong></footer>
+        </div>
+      </article>
+      <div v-if="!filtered.length" class="cw-empty"><strong>没有符合条件的项目</strong><p>调整关键词或筛选条件再试一次。</p></div>
+    </section>
+
+    <footer class="atlas-footer"><div><h2>页面维护者</h2><p>数据、逻辑和界面由三位机器人分别维护。</p></div><ContributorList :names="allContributors" /></footer>
+  </div>
+</template>
+
+<style scoped>
+.atlas-header { display: flex; align-items: end; justify-content: space-between; gap: 30px; padding: 6px 0 24px; border-bottom: 1px solid var(--cw-border); }
+.atlas-header h1 { margin: 5px 0 3px; font-family: Georgia, "Noto Serif SC", serif; font-size: clamp(2rem, 5vw, 3rem); line-height: 1.2; }
+.atlas-header p:last-child { max-width: 620px; margin: 0; color: var(--cw-muted); font-size: .9rem; }
+.atlas-header > strong { color: var(--cw-accent); font-family: Georgia, serif; font-size: 2.3rem; }
+.atlas-header > strong small { color: var(--cw-muted); font: 500 .7rem Inter, sans-serif; }
+.atlas-toolbar { position: sticky; top: 56px; z-index: 15; display: grid; grid-template-columns: 1fr repeat(3, 135px); margin-bottom: 18px; border: 1px solid var(--cw-border); border-top: 0; background: var(--cw-header); backdrop-filter: blur(8px); }
+.atlas-toolbar label { display: flex; align-items: center; min-height: 48px; padding: 0 13px; border-left: 1px solid var(--cw-border); }
+.atlas-toolbar label > span { margin-right: auto; color: var(--cw-muted); font-size: .68rem; font-weight: 700; }
+.atlas-toolbar select { max-width: 76px; color: var(--cw-text); border: 0; outline: 0; background: transparent; font-size: .76rem; }
+.atlas-toolbar .atlas-search { border-left: 0; }
+.atlas-search > span { color: var(--cw-accent) !important; font-size: 1.1rem !important; }
+.atlas-search input { min-width: 0; flex: 1; color: var(--cw-text); border: 0; outline: 0; background: transparent; }
+.atlas-grid { display: grid; grid-template-columns: repeat(2, 1fr); gap: 10px; }
+.atlas-card { display: grid; grid-template-columns: 44px 1fr; min-width: 0; padding: 16px; border: 1px solid var(--cw-border); border-radius: var(--cw-radius); background: var(--cw-surface); }
+.atlas-card:hover { border-color: var(--cw-accent); }
+.atlas-card__index { color: var(--cw-muted); font: .72rem Georgia, serif; }
+.atlas-card__meta { display: flex; justify-content: space-between; color: var(--cw-muted); font-size: .66rem; }
+.atlas-card__meta b { color: var(--cw-gold); }
+.atlas-card h2 { margin: 5px 0 3px; font-family: Georgia, "Noto Serif SC", serif; font-size: 1.06rem; }
+.atlas-card p { min-height: 2.8em; margin: 0; color: var(--cw-muted); font-size: .78rem; line-height: 1.5; }
+.atlas-card footer { display: flex; justify-content: space-between; margin-top: 12px; padding-top: 9px; border-top: 1px solid var(--cw-border); font-size: .66rem; }
+.atlas-card footer span { color: var(--cw-muted); }
+.atlas-footer { display: flex; align-items: center; justify-content: space-between; gap: 25px; margin-top: 34px; padding: 22px 0; border-top: 1px solid var(--cw-border); }
+.atlas-footer h2 { margin: 0; font-family: Georgia, "Noto Serif SC", serif; font-size: 1rem; }
+.atlas-footer p { margin: 2px 0 0; color: var(--cw-muted); font-size: .75rem; }
+@media (max-width: 760px) { .atlas-toolbar { position: static; grid-template-columns: 1fr 1fr; border-top: 1px solid var(--cw-border); } .atlas-search { grid-column: 1 / -1; } .atlas-grid { grid-template-columns: 1fr; } }
+@media (max-width: 560px) { .atlas-header { align-items: start; flex-direction: column; } .atlas-toolbar label { border-bottom: 1px solid var(--cw-border); } .atlas-footer { align-items: start; flex-direction: column; } }
+</style>

package/template/components/pages/AtlasPage.vue

@@ -0,0 +1,7 @@
+<script setup lang="ts">
+import ItemAtlas from '../ItemAtlas.vue'
+</script>
+
+<template>
+  <ItemAtlas />
+</template>

package/template/content/archive.md

@@ -0,0 +1,6 @@
+---
+layout: archive
+title: 归档索引
+description: 浏览 CoCoWiki 中的全部页面与内容
+search: false
+---

package/template/content/atlas.page.json

@@ -0,0 +1,8 @@
+{
+  "title": "组件图鉴",
+  "description": "由静态 JSON 驱动的纯 Vue 功能页示例",
+  "type": "special",
+  "category": "功能示例",
+  "tags": ["Vue", "筛选", "静态数据"],
+  "contributors": ["杰登", "皙折", "卡卡"]
+}

package/template/content/atlas.page.vue

@@ -0,0 +1,7 @@
+<script setup lang="ts">
+import AtlasPage from '../components/pages/AtlasPage.vue'
+</script>
+
+<template>
+  <AtlasPage />
+</template>

package/template/content/contributors.md

@@ -0,0 +1,6 @@
+---
+layout: contributors
+title: 贡献者
+description: 查看参与建设 CoCoWiki 的所有贡献者
+search: false
+---

package/template/content/index.md

@@ -0,0 +1,21 @@
+---
+layout: home
+title: __COCOWIKI_SITE_NAME__
+description: 一个由 Markdown、Vue 和静态数据组成的轻量资料站示例
+search: false
+hero:
+  eyebrow: SEARCH-FIRST KNOWLEDGE BASE
+  name: __COCOWIKI_SITE_NAME__
+  text: 让知识自然生长。
+  tagline: 把散落的故事，慢慢收进这里。
+  search:
+    placeholder: 搜索人物、设定或任何关键词…
+  actions:
+    - theme: brand
+      text: 开始探索
+      link: /welcome
+    - theme: alt
+      text: 浏览归档
+      link: /archive
+  note: 为小型 Wiki、世界观设定集与资料归档而设计。
+---

package/template/content/search.md

@@ -0,0 +1,6 @@
+---
+layout: search
+title: 搜索资料库
+description: 搜索标题、别名、标签与正文
+search: false
+---

package/template/content/welcome.md

@@ -0,0 +1,88 @@
+---
+title: 欢迎使用 CoCoWiki
+description: 把散落的故事，慢慢收进这里。
+type: guide
+category: 使用指南
+tags:
+  - CoCoWiki
+  - Markdown
+  - Vue
+contributors:
+  - 皙折
+---
+
+# 欢迎使用 CoCoWiki
+
+**CoCoWiki 是一个基于 VitePress 深度封装的轻量静态 Wiki 框架。**
+
+它面向小型 Wiki、世界观资料站、设定集和资料归档站。你主要负责写 Markdown、Vue 组件和静态数据，CoCoWiki 负责路由、主题、搜索、归档与静态构建。
+
+CoCoWiki 不要求内容拥有完整目录或固定阅读顺序，因此尤其适合碎片内容较多、词条类型复杂的资料库。访问者不必沿着目录逐页阅读，而是通过全站搜索直接找到需要的内容。
+
+## 三种页面形式
+
+| 页面形式 | 适合内容 |
+| --- | --- |
+| 普通 Markdown | 人物、地点、概念、说明文档 |
+| Markdown + Vue | 在文章中嵌入图表、列表或交互组件 |
+| 纯 Vue 页面 | 图鉴、时间线、关系图和复杂筛选页面 |
+
+当前页面是普通 Markdown 页面；Markdown 中也可以直接使用 `components/` 中自动注册的 Vue 组件。[[组件图鉴]] 则是一张从 `.page.vue` 生成的纯 Vue 页面。
+
+## 内容与 Frontmatter
+
+页面元信息写在 Markdown 顶部的 Frontmatter 中。标题、描述、分类、标签、别名和贡献者会自动用于内容页、搜索、归档和贡献统计。
+
+```md
+---
+title: 示例词条
+description: 用一句话介绍当前内容
+category: 世界观
+tags: [设定, 示例]
+aliases: [另一个名字]
+contributors: [Mueo]
+---
+
+# 示例词条
+
+正文从这里开始。
+```
+
+## 搜索与归档
+
+搜索索引在构建期从 Frontmatter 与正文生成，可以检索标题、描述、别名、标签、贡献者和正文，不需要服务器。归档页默认汇总全部内容页面，并按照分类展示。
+
+## Markdown 扩展
+
+标准 Markdown 可以照常使用，此外还提供少量适合 Wiki 的扩展：
+
+- 使用双方括号创建站内链接，例如 `[[组件图鉴]]`。
+- 使用双竖线隐藏剧透内容。
+- 使用 `info`、`tip`、`warning`、`danger` 和 `details` 容器强调不同信息。
+
+||这是一段可点击显示的剧透，用来验证桌面端与移动端交互。||
+
+:::tip 搜索优先
+面对无需按顺序阅读的碎片化资料，先搜索关键词通常比展开多级目录更直接。
+:::
+
+:::warning 构建期优先
+能在构建期完成的索引、路由和页面生成，不会被放到运行时重复处理。
+:::
+
+## 主题与静态部署
+
+默认主题支持 Light、Dark 和 System 三种模式，包含响应式导航、移动端布局、内容目录以及可配置的前后页导航。Markdown 页默认显示右侧目录，可以通过 `content.outline` 全局设置，也可以在单页 Frontmatter 中用 `outline: false` 关闭；纯 Vue 页面不会自动生成目录。
+
+构建结果是纯 HTML、CSS、JavaScript 和静态资源，可部署到 GitHub Pages、Cloudflare Pages、Vercel、Netlify 或 Nginx。
+
+## 开始使用
+
+```bash
+pnpm create cocowiki my-wiki
+cd my-wiki
+pnpm install
+pnpm dev
+```
+
+之后只需要在 `content/` 中写 Markdown、在 `components/` 中添加 Vue 组件，或在 `data/` 中维护 JSON / TypeScript 数据。

package/template/data/contributors.json

@@ -0,0 +1,17 @@
+{
+  "杰登": {
+    "name": "杰登",
+    "initials": "JD",
+    "role": "大哥 · 数据层"
+  },
+  "皙折": {
+    "name": "皙折",
+    "initials": "XZ",
+    "role": "二姐 · 交互层"
+  },
+  "卡卡": {
+    "name": "卡卡",
+    "initials": "KK",
+    "role": "三妹 · 逻辑层"
+  }
+}

package/template/data/items.json

@@ -0,0 +1,34 @@
+[
+  {
+    "id": "content-index",
+    "name": "内容索引",
+    "rarity": "core",
+    "category": "data",
+    "description": "在构建期从 Markdown 与 Frontmatter 中整理出的搜索数据。",
+    "contributors": ["杰登"]
+  },
+  {
+    "id": "page-state",
+    "name": "页面状态",
+    "rarity": "stable",
+    "category": "logic",
+    "description": "筛选、排序和主题模式使用的轻量客户端状态。",
+    "contributors": ["卡卡"]
+  },
+  {
+    "id": "search-panel",
+    "name": "搜索面板",
+    "rarity": "stable",
+    "category": "interface",
+    "description": "能够通过键盘或导航快速打开的全站检索入口。",
+    "contributors": ["皙折"]
+  },
+  {
+    "id": "vue-page",
+    "name": "Vue 专属页",
+    "rarity": "extended",
+    "category": "interface",
+    "description": "以 .page.vue 约定创建的纯 Vue 功能页面。",
+    "contributors": ["皙折", "卡卡"]
+  }
+]

package/template/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "cocowiki-site",
+  "version": "0.1.0",
+  "private": true,
+  "type": "module",
+  "scripts": {
+    "dev": "cocowiki dev",
+    "build": "cocowiki build",
+    "preview": "cocowiki preview"
+  },
+  "dependencies": {
+    "cocowiki": "^0.2.2",
+    "vitepress": "^1.6.4",
+    "vue": "^3.5.42"
+  }
+}

package/template/pnpm-workspace.yaml

@@ -0,0 +1,2 @@
+allowBuilds:
+  esbuild: true