From 0ca1a533069ed7fcfde93574ddedae0171d4e08f Mon Sep 17 00:00:00 2001 From: sanbuphy Date: Tue, 3 Mar 2026 16:39:07 +0800 Subject: [PATCH] feat(seo): add sitemap generation and improve seo metadata - Add sitemap generator script that scans markdown files and creates multilingual sitemap - Update build script to include sitemap generation - Add robots.txt and llms.txt files for crawlers - Enhance SEO metadata with better structured data and hreflang tags - Fix stage-0 URL in README --- README.md | 2 +- docs/.vitepress/config.mjs | 107 ++- docs/public/llms.txt | 53 ++ docs/public/robots.txt | 11 + docs/public/sitemap.xml | 1212 ++++++++++++++++++++++++++++++++++ package.json | 7 +- scripts/generate-sitemap.mjs | 223 +++++++ 7 files changed, 1595 insertions(+), 20 deletions(-) create mode 100644 docs/public/llms.txt create mode 100644 docs/public/robots.txt create mode 100644 docs/public/sitemap.xml create mode 100644 scripts/generate-sitemap.mjs diff --git a/README.md b/README.md index 2f2564e..537609b 100644 --- a/README.md +++ b/README.md @@ -122,7 +122,7 @@ | 阶段 | 适用人群 | 核心技能 | 产出 | | :--- | :--- | :--- | :--- | -| [**第一阶段：零基础入门**](https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/) | 零基础/产品经理 | 学习地图、AI 编程入门、AI IDE、产品思维、原型设计、AI 能力集成 | 互动小游戏、完整的产品原型 | +| [**第一阶段：零基础入门**](https://datawhalechina.github.io/easy-vibe/zh-cn/stage-0/) | 零基础/产品经理 | 学习地图、AI 编程入门、AI IDE、产品思维、原型设计、AI 能力集成 | 互动小游戏、完整的产品原型 | | [**第二阶段：全栈开发**](https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/) | 开发者 | 全栈开发、数据库、AI 集成、部署运维 | 可上线的全栈 AI 应用 | | [**第三阶段：高级开发**](https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/) | 进阶开发者 | Claude Code 进阶、多平台开发 | 生产级多平台应用 | | [**附录：基础知识**](https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/) | 全员 | 计算机基础、AI 入门、9 大知识领域 | 80+ 交互式专题 | diff --git a/docs/.vitepress/config.mjs b/docs/.vitepress/config.mjs index 2cce2c3..f61c173 100644 --- a/docs/.vitepress/config.mjs +++ b/docs/.vitepress/config.mjs @@ -98,6 +98,18 @@ const getSeoHead = (locale, title, description, path = '') => { const canonicalUrl = path ? `${siteUrl}${path}` : `${siteUrl}/${locale}/` const ogImageUrl = `${siteUrl}${base}logo.png` + // 从路径中提取页面相对路径（去掉语言前缀） + const getRelativePath = (fullPath, currentLocale) => { + if (!fullPath) return '' + const prefix = `/${currentLocale}/` + if (fullPath.startsWith(prefix)) { + return fullPath.slice(prefix.length) + } + return fullPath.replace(/^\//, '') + } + + const relativePath = getRelativePath(path, locale) + const head = [ ['link', { rel: 'icon', href: `${base}logo.png`.replace('//', '/') }], [ @@ -143,19 +155,24 @@ const getSeoHead = (locale, title, description, path = '') => { ['meta', { name: 'robots', content: 'index,follow' }], ['meta', { name: 'googlebot', content: 'index,follow' }], ['meta', { name: 'baiduspider', content: 'index,follow' }], + ['meta', { name: 'bingbot', content: 'index,follow' }], ['meta', { name: 'distribution', content: 'global' }], ['meta', { name: 'rating', content: 'general' }], ['meta', { name: 'revisit-after', content: '7 days' }] ] - // 添加 hreflang 标签 + // 添加 hreflang 标签 - 指向相同页面的不同语言版本 Object.keys(localeMap).forEach((lang) => { + let alternateUrl = `${siteUrl}/${lang}/` + if (relativePath) { + alternateUrl = `${siteUrl}/${lang}/${relativePath}` + } head.push([ 'link', { rel: 'alternate', hreflang: localeMap[lang].hreflang, - href: `${siteUrl}/${lang}/` + href: alternateUrl } ]) }) @@ -184,7 +201,10 @@ const getSeoHead = (locale, title, description, path = '') => { logo: { '@type': 'ImageObject', url: ogImageUrl - } + }, + sameAs: [ + 'https://github.com/datawhalechina/easy-vibe' + ] }, mainEntity: { '@type': 'Course', @@ -194,30 +214,85 @@ const getSeoHead = (locale, title, description, path = '') => { '@type': 'Organization', name: 'Datawhale', sameAs: 'https://github.com/datawhalechina/easy-vibe' - } + }, + educationalLevel: 'Beginner to Advanced', + learningResourceType: 'Course' } } head.push(['script', { type: 'application/ld+json' }, JSON.stringify(jsonLd)]) - // 添加 BreadcrumbList 结构化数据 - const breadcrumbJsonLd = { - '@context': 'https://schema.org', - '@type': 'BreadcrumbList', - itemListElement: [ + // 生成动态 BreadcrumbList 结构化数据 + const generateBreadcrumbList = () => { + const items = [ { '@type': 'ListItem', position: 1, - name: '首页', - item: siteUrl - }, - { - '@type': 'ListItem', - position: 2, - name: locale === 'zh-cn' ? '教程' : 'Tutorial', + name: locale === 'zh-cn' ? '首页' : 'Home', item: `${siteUrl}/${locale}/` } ] + + if (relativePath) { + // 解析路径生成面包屑 + const pathParts = relativePath.split('/').filter(Boolean) + let currentPath = '' + + // 路径分段名称映射 + const segmentNames = { + 'zh-cn': { + 'stage-0': '幼儿园', + 'stage-1': 'AI产品经理', + 'stage-2': '初中级开发工程师', + 'stage-3': '高级开发工程师', + 'appendix': '附录', + 'guide': '指南', + 'frontend': '前端', + 'backend': '后端', + 'ai-capabilities': 'AI能力', + 'core-skills': '核心技能', + 'cross-platform': '跨平台开发', + 'personal-brand': '个人品牌', + 'ai-advanced': 'AI进阶' + }, + 'en': { + 'stage-0': 'Kindergarten', + 'stage-1': 'AI Product Manager', + 'stage-2': 'Junior Developer', + 'stage-3': 'Senior Developer', + 'appendix': 'Appendix', + 'guide': 'Guide', + 'frontend': 'Frontend', + 'backend': 'Backend', + 'ai-capabilities': 'AI Capabilities', + 'core-skills': 'Core Skills', + 'cross-platform': 'Cross-platform', + 'personal-brand': 'Personal Brand', + 'ai-advanced': 'AI Advanced' + } + } + + const names = segmentNames[locale] || segmentNames['zh-cn'] + + pathParts.forEach((part, index) => { + currentPath += `/${part}` + const name = names[part] || part.replace(/-/g, ' ') + items.push({ + '@type': 'ListItem', + position: index + 2, + name: name, + item: `${siteUrl}/${locale}${currentPath}/` + }) + }) + } + + return { + '@context': 'https://schema.org', + '@type': 'BreadcrumbList', + itemListElement: items + } } + + const breadcrumbJsonLd = generateBreadcrumbList() head.push(['script', { type: 'application/ld+json', class: 'breadcrumb-jsonld' }, JSON.stringify(breadcrumbJsonLd)]) return head diff --git a/docs/public/llms.txt b/docs/public/llms.txt new file mode 100644 index 0000000..b343a79 --- /dev/null +++ b/docs/public/llms.txt @@ -0,0 +1,53 @@ +# Easy-Vibe - AI Vibe Coding Curriculum +# https://datawhalechina.github.io/easy-vibe +# +# This file helps AI models and agents understand our project structure +# Created for: OpenClaw, Claude, Cursor, Trae, and other AI coding assistants + +== Project Overview == + +Easy-Vibe is an educational curriculum for learning AI Vibe Coding from zero to advanced levels. +It's built with VitePress and provides interactive tutorials in multiple languages. + +== Learning Path == + +Stage 0 (Kindergarten): Learn AI programming through games +- Learning map visualization +- AI capabilities through interactive games + +Stage 1 (AI Product Manager): Build AI-powered web application prototypes +- Finding great ideas +- AI IDE introduction (Cursor, Claude Code) +- Building prototypes +- Integrating AI capabilities + +Stage 2 (Junior/Mid-level Developer): Full-stack development +- Frontend development +- Backend development with databases +- Deployment and DevOps + +Stage 3 (Senior Developer): Cross-platform development +- WeChat mini-programs +- Android and iOS apps +- MCP (Model Context Protocol) +- RAG and LangGraph + +== Content Structure == + +/docs/ + - zh-cn/ (Simplified Chinese - primary, complete) + - en/ (English - complete) + - zh-tw/, ja-jp/, ko-kr/, etc. (partial translations) + - stage-0/, stage-1/, stage-2/, stage-3/ (curriculum stages) + - appendix/ (reference materials with interactive components) + +== Key Files == + +- CLAUDE.md: Project-specific instructions for AI assistants +- package.json: Dependencies and scripts +- docs/.vitepress/config.mjs: Site configuration + +== Contact == + +- GitHub: https://github.com/datawhalechina/easy-vibe +- Organization: Datawhale China diff --git a/docs/public/robots.txt b/docs/public/robots.txt new file mode 100644 index 0000000..79aafd7 --- /dev/null +++ b/docs/public/robots.txt @@ -0,0 +1,11 @@ +# robots.txt for Easy-Vibe +# https://datawhalechina.github.io/easy-vibe + +User-agent: * +Allow: / + +# Sitemap location +Sitemap: https://datawhalechina.github.io/easy-vibe/sitemap.xml + +# Crawl-delay for polite crawling +Crawl-delay: 1 diff --git a/docs/public/sitemap.xml b/docs/public/sitemap.xml new file mode 100644 index 0000000..66267c9 --- /dev/null +++ b/docs/public/sitemap.xml @@ -0,0 +1,1212 @@ + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/ + 2026-03-03T08:08:45.902Z + weekly + 1.0 + + + + + + + + + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/algorithm-thinking/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/compilers/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/computer-networks/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/computer-organization/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/data-encoding-storage/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/data-structures/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/operating-systems/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/power-on-to-web/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/programming-languages/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/transistor-to-cpu/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/type-systems/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/1-computer-fundamentals/vibe-coding-fullstack/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/command-line-shell/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/debugging-art/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/debugging-art/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/environment-path/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/git-version-control/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/ide-basics/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/package-managers/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/ports-localhost/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/regex/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/2-development-tools/ssh-authentication/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/a11n-i18n/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/browser-as-os-rendering/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/frontend-engineering/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/frontend-framework-nature/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/frontend-frameworks/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/frontend-project-architecture/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/graphics-animation/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/html-css-layout/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/javascript-deep-dive/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/javascript-runtime/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/realtime-communication/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/routing-navigation/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/state-management/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/typescript/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/3-browser-and-frontend/web-performance/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/api-design/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/api-intro/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/async-task-queues/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/auth-authorization/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/backend-languages/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/backend-layered-architecture/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/backend-project-architecture/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/caching/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/client-languages/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/concurrency-async/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/cross-platform/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/domain-specific-languages/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/file-storage/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/http-protocol/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/message-queues/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/rate-limiting-backpressure/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/request-journey/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/search-engines/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/serialization/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/4-server-and-backend/web-frameworks/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/ab-testing/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/data-analysis/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/data-governance/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/data-models/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/data-tracking/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/data-visualization/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/5-data/database-fundamentals/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/6-architecture-and-system-design/distributed-systems/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/6-architecture-and-system-design/high-availability/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/6-architecture-and-system-design/monolith-to-microservices/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/6-architecture-and-system-design/system-design-methodology/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/ci-cd/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/cloud-iam/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/cloud-platforms/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/cloud-storage-cdn/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/dns-https/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/docker-containers/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/gateway-proxy/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/incident-response/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/infrastructure-as-code/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/kubernetes/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/linux-basics/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/load-balancing-gateway/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/7-infrastructure-and-operations/monitoring-logging/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/ai-agents/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/ai-capability-dictionary/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/ai-history/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/ai-native-app-design/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/ai-protocols/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/context-engineering/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/embedding-vector-retrieval/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/image-generation/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/llm-principles/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/model-finetuning-deployment/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/multimodal-models/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/neural-networks/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/prompt-engineering/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/rag/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/speech-synthesis-recognition/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/8-artificial-intelligence/transformer-attention/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/code-quality-refactoring/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/design-patterns/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/open-source-collaboration/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/security-thinking/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/technical-writing/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/technology-selection/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/9-engineering-excellence/testing-strategies/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/appendix/ + 2026-03-03T08:08:45.902Z + weekly + 0.7 + + + + + + + + + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/guide/introduction/ + 2026-03-03T08:08:45.902Z + weekly + 0.6 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-0/0.1-learning-map/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-0/0.2-ai-capabilities-through-games/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-0/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + + + + + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/1.0-finding-great-idea/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/1.1-introduction-to-ai-ide/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/1.2-building-prototype/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/1.3-integrating-ai-capabilities/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/1.4-complete-project-practice/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-a-product-thinking/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-articles/example0-1/vibe-coding-tools-snake-game-tutorial/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-articles/example0-2/vibe-coding-tools-build-website-with-ai-coding-and-design-agents/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-b-common-errors/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-c-consumer-scenarios/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-consumer-scenarios/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-1/appendix-industry-scenarios/ + 2026-03-03T08:08:45.902Z + weekly + 0.9 + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/ai-capabilities/2.1-dify-knowledge-base/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/assignments/2.1-fullstack-app/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/assignments/2.2-modern-frontend-trae/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.2-database-supabase/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.3-ai-interface-code/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.4-git-workflow/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.5-zeabur-deployment/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.6-modern-cli/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/backend/2.7-stripe-payment/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.0-lovart-assets/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.1-figma-mastergo/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.2-ui-design/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.3-multi-product-ui/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.4-llm-skills-beautiful/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.5-hogwarts-portraits/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.6-design-to-code/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/frontend/2.7-modern-component-library/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-2/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + + + + + + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/ai-advanced/3.a1-rag-introduction/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/ai-advanced/3.a2-langgraph-advanced-rag/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/agent-teams/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/basics/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/claude-agent-sdk/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/long-running-tasks/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/mcp/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/mobile-development/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/skills/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/spec-coding/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/superpowers/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/core-skills/workflow/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.10-electron-voice-to-text/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.11-nft-minting/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.12-vscode-extension/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.13-qt-industrial-hmi/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.3-wechat-miniprogram/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.4-wechat-miniprogram-backend/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.5-android-app/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.6-ios-app/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.8-pwa-local-app/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/cross-platform/3.9-browser-ai-extension/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + + + + + + + + + + + https://datawhalechina.github.io/easy-vibe/zh-cn/stage-3/personal-brand/3.7-personal-website-blog/ + 2026-03-03T08:08:45.902Z + weekly + 0.8 + + + diff --git a/package.json b/package.json index 0abe8e9..263cc85 100644 --- a/package.json +++ b/package.json @@ -5,14 +5,15 @@ "type": "module", "scripts": { "dev": "vitepress dev docs", - "build": "vitepress build docs", - "build:force": "vitepress build docs --force", + "build": "npm run sitemap && vitepress build docs", + "build:force": "npm run sitemap && vitepress build docs --force", "preview": "vitepress preview docs", "format": "prettier --write .", "verify": "bash scripts/verify.sh", "lint": "eslint docs/.vitepress/theme", "lint:fix": "eslint docs/.vitepress/theme --fix", - "prepare": "husky" + "prepare": "husky", + "sitemap": "node scripts/generate-sitemap.mjs" }, "keywords": [ "easy-vibe", diff --git a/scripts/generate-sitemap.mjs b/scripts/generate-sitemap.mjs new file mode 100644 index 0000000..1bd2800 --- /dev/null +++ b/scripts/generate-sitemap.mjs @@ -0,0 +1,223 @@ +#!/usr/bin/env node +/** + * Sitemap Generator for Easy-Vibe + * Generates sitemap.xml for all pages in the documentation + */ + +import fs from 'fs' +import path from 'path' +import { fileURLToPath } from 'url' + +const __filename = fileURLToPath(import.meta.url) +const __dirname = path.dirname(__filename) + +const docsDir = path.resolve(__dirname, '../docs') +const publicDir = path.resolve(__dirname, '../docs/public') + +// 支持的语言 +const locales = ['zh-cn', 'en', 'zh-tw', 'ja-jp', 'ko-kr', 'es-es', 'fr-fr', 'de-de', 'ar-sa', 'vi-vn'] + +// 基础 URL (根据部署环境动态确定) +const getBaseUrl = () => { + if (process.env.VERCEL_URL) { + return `https://${process.env.VERCEL_URL}` + } + if (process.env.EDGEONE_URL) { + return `https://${process.env.EDGEONE_URL}` + } + if (process.env.SITE_URL) { + return process.env.SITE_URL + } + return 'https://datawhalechina.github.io/easy-vibe' +} + +const siteUrl = getBaseUrl() + +// 扫描目录中的所有 markdown 文件 +function scanMarkdownFiles(dir, basePath = '') { + const files = [] + const entries = fs.readdirSync(dir, { withFileTypes: true }) + + for (const entry of entries) { + const fullPath = path.join(dir, entry.name) + const relativePath = path.join(basePath, entry.name) + + if (entry.isDirectory()) { + // 跳过特殊目录 + if (entry.name === '.vitepress' || entry.name === 'node_modules' || entry.name === 'dist' || entry.name === 'public') { + continue + } + files.push(...scanMarkdownFiles(fullPath, relativePath)) + } else if (entry.isFile() && entry.name.endsWith('.md')) { + files.push(relativePath) + } + } + + return files +} + +// 将 markdown 路径转换为 URL 路径 +function mdPathToUrl(mdPath, locale) { + // 移除 .md 扩展名 + let urlPath = mdPath.replace(/\.md$/, '') + + // 如果是 index.md，只保留目录 + if (urlPath.endsWith('/index')) { + urlPath = urlPath.slice(0, -6) + } else if (urlPath === 'index') { + urlPath = '' + } + + // 构建完整 URL + return `${siteUrl}/${locale}/${urlPath}${urlPath ? '/' : ''}` +} + +// 生成 sitemap XML +function generateSitemap(urls) { + const now = new Date().toISOString() + + let xml = '\n' + xml += '${escapeXml(urlInfo.loc)}\n` + xml += ` ${now}\n` + xml += ` weekly\n` + xml += ` ${urlInfo.priority.toFixed(1)}\n` + + // 添加 hreflang alternates + for (const alternate of urlInfo.alternates) { + xml += ` \n` + } + + xml += ' \n' + } + + xml += '\n' + return xml +} + +function escapeXml(str) { + return str + .replace(/&/g, '&') + .replace(//g, '>') + .replace(/"/g, '"') + .replace(/'/g, ''') +} + +// 主函数 +function main() { + console.log('🔍 Scanning documentation files...') + + const allUrls = [] + const localePaths = new Map() + + // 首先扫描中文内容作为基准 + const zhCnDir = path.join(docsDir, 'zh-cn') + let baseFiles = [] + + if (fs.existsSync(zhCnDir)) { + baseFiles = scanMarkdownFiles(zhCnDir) + } else { + // 如果没有 zh-cn 目录，扫描 docs 根目录 + baseFiles = scanMarkdownFiles(docsDir).filter(f => !f.includes('/')) + } + + console.log(`📄 Found ${baseFiles} base pages`) + + // 为每个文件生成 URL 信息 + for (const baseFile of baseFiles) { + // 跳过根目录的 index.md（特殊处理） + if (baseFile === 'index.md') continue + + const urlInfo = { + loc: '', + priority: getPriority(baseFile), + alternates: [] + } + + // 为每个语言版本生成 alternate + for (const locale of locales) { + const localeDir = path.join(docsDir, locale) + const localeFile = path.join(localeDir, baseFile) + + // 检查该语言版本是否存在 + if (fs.existsSync(localeFile)) { + const url = mdPathToUrl(baseFile, locale) + urlInfo.alternates.push({ + hreflang: getHreflangCode(locale), + href: url + }) + + // 设置主要语言版本为 zh-cn + if (locale === 'zh-cn') { + urlInfo.loc = url + } + } + } + + // 如果有至少一个语言版本存在 + if (urlInfo.alternates.length > 0) { + // 如果没有 zh-cn 版本，使用第一个可用的 + if (!urlInfo.loc) { + urlInfo.loc = urlInfo.alternates[0].href + } + allUrls.push(urlInfo) + } + } + + // 添加首页 + const homeAlternates = [] + for (const locale of locales) { + homeAlternates.push({ + hreflang: getHreflangCode(locale), + href: `${siteUrl}/${locale}/` + }) + } + allUrls.unshift({ + loc: `${siteUrl}/zh-cn/`, + priority: 1.0, + alternates: homeAlternates + }) + + console.log(`🌐 Generating sitemap with ${allUrls.length} URLs...`) + + const sitemapXml = generateSitemap(allUrls) + const outputPath = path.join(publicDir, 'sitemap.xml') + fs.writeFileSync(outputPath, sitemapXml, 'utf-8') + + console.log(`✅ Sitemap generated at ${outputPath}`) + console.log(`📊 Statistics:`) + console.log(` - Total URLs: ${allUrls.length}`) + console.log(` - Locales: ${locales.length}`) + console.log(` - Site URL: ${siteUrl}`) +} + +function getPriority(filePath) { + if (filePath.includes('stage-0') || filePath.includes('stage-1')) return 0.9 + if (filePath.includes('stage-2')) return 0.8 + if (filePath.includes('stage-3')) return 0.8 + if (filePath.includes('appendix')) return 0.7 + return 0.6 +} + +function getHreflangCode(locale) { + const map = { + 'zh-cn': 'zh-CN', + 'en': 'en', + 'zh-tw': 'zh-TW', + 'ja-jp': 'ja', + 'ko-kr': 'ko', + 'es-es': 'es', + 'fr-fr': 'fr', + 'de-de': 'de', + 'ar-sa': 'ar', + 'vi-vn': 'vi' + } + return map[locale] || locale +} + +main()