Use Markdown image syntax in README and make coverpage content the VitePress homepage by Copilot · Pull Request #4 · insoxin/API

Copilot · 2026-03-29T02:52:16Z

先执行当前文档构建，确认基线通过
定位并确认 Docsify 入口与静态资源引用
最小范围删除 Docsify 环境相关文件与配置
运行文档构建验证改动不破坏 VitePress
复查变更范围并提交

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Agent-Logs-Url: https://github.com/insoxin/API/sessions/8496b6bc-948b-4992-8d5a-bd65fff1f2b7 Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

Agent-Logs-Url: https://github.com/insoxin/API/sessions/b57a0366-9697-42d9-9f62-44ca597c599a Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

vercel · 2026-03-29T02:52:21Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
api-tmwy	Error		Mar 29, 2026 2:57am

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 07b6126489

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

chatgpt-codex-connector · 2026-03-29T02:57:05Z

.vitepress/config.ts

+  description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',
+  ignoreDeadLinks: true,
+  markdown: {
+    html: false


Re-enable HTML rendering for markdown content

Setting markdown.html to false escapes raw HTML in every Markdown page, but this docs set already depends on inline HTML for user-visible content (for example, pages like 壁纸模块.md include <img ...> blocks outside code fences). With this option disabled, those sections render as literal tags instead of images/embeds, which is a broad functional regression in the migrated VitePress site.

Useful? React with 👍 / 👎.

Copilot

Pull request overview

This PR migrates the documentation presentation toward VitePress by introducing a VitePress homepage (index.md) based on the existing Docsify coverpage content and standardizing README images to Markdown syntax, along with adding a Node/VitePress build pipeline for GitHub Pages.

Changes:

Add VitePress tooling/config (package.json, lockfile, .vitepress/config.ts) and update GitHub Pages workflow to build/deploy .vitepress/dist.
Add root index.md populated with _coverpage.md content so / renders that content in VitePress.
Replace HTML <img> tags in README.md with Markdown image syntax and add .gitignore entries for Node/VitePress artifacts.

Reviewed changes

Copilot reviewed 5 out of 7 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
`package.json`	Introduces VitePress scripts/dependency for local dev/build and CI.
`package-lock.json`	Locks VitePress (and transitive) dependencies for reproducible CI builds.
`index.md`	New VitePress homepage content mirroring existing coverpage text.
`README.md`	Normalizes traffic-card images to Markdown image syntax.
`.vitepress/config.ts`	Adds VitePress site config, navigation/sidebar, and head scripts.
`.gitignore`	Ignores `node_modules`, logs, and VitePress build output.
`.github/workflows/pages.yml`	Switches Pages deployment to a Node-based VitePress build + deploy flow.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-29T02:57:31Z

.vitepress/config.ts

+export default defineConfig({
+  lang: 'zh-CN',
+  title: '姬长信API For Docker官方文档',
+  description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',


The VitePress config doesn’t set base. When deploying to GitHub Pages for a project repo (e.g. /API/), VitePress will otherwise generate asset links rooted at /, which typically breaks CSS/JS on the published site. Consider setting base appropriately (or deriving it from an env var in CI) to match the Pages URL.

Suggested change

description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',

description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',

base:

process.env.DOCS_BASE ||

(process.env.GITHUB_REPOSITORY

? '/' + process.env.GITHUB_REPOSITORY.split('/')[1] + '/'

: '/'),

Copilot · 2026-03-29T02:57:31Z

index.md

+# 姬长信 API For Docker <small>始于 2017</small>
+


This heading uses an inline HTML <small> tag. With the current VitePress config (markdown.html: false), it will be escaped and shown as text; even with HTML enabled it can affect the generated heading id/anchor. Consider rewriting this as pure Markdown (e.g., move “始于 2017” to a separate line) to avoid rendering/anchor issues.

Suggested change

# 姬长信 API For Docker <small>始于 2017</small>

# 姬长信 API For Docker

_始于 2017_

Copilot · 2026-03-29T02:57:31Z

index.md

+* 条款：姬长信 API 拥有所有运行权，在某些特定情况下有权禁止你的网站调用。
+* 禁止用于违法、商业用途，不接受定制功能性捐助！
+[GitHub](https://github.com/insoxin/API/)
+[开始](#姬长信api-for-docker)


[开始](#姬长信api-for-docker) is very likely to be a broken in-page anchor in VitePress because heading ids are slugified (typically inserting hyphens and including additional heading text). Consider linking to a real route (e.g. the first doc page like /公益中国) or updating the hash to match the actual generated heading id.

Suggested change

[开始](#姬长信api-for-docker)

[开始](#姬长信-api-for-docker-始于-2017)

Copilot · 2026-03-29T02:57:31Z

package.json

+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",


license is set to ISC, but the repository LICENSE file is GNU AGPLv3. This package metadata should match the repo’s actual license (e.g. AGPL-3.0-or-later) to avoid publishing incorrect licensing information.

Suggested change

"license": "ISC",

"license": "AGPL-3.0-or-later",

Copilot · 2026-03-29T02:57:32Z

.vitepress/config.ts

+  description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',
+  ignoreDeadLinks: true,
+  markdown: {
+    html: false


markdown.html is set to false, but many existing Markdown pages in this repo include raw HTML (e.g., <img ...>). With HTML disabled, those tags will render as literal text and break the docs layout across multiple pages. Either remove this override / set markdown.html: true, or migrate all existing pages away from raw HTML before disabling it.

Suggested change

html: false

html: true

Agent-Logs-Url: https://github.com/insoxin/API/sessions/02f46b2e-7093-484b-b7b4-9ac478f72a9f Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

cloudflare-workers-and-pages · 2026-03-29T02:57:43Z

Deploying api with Cloudflare Pages

Latest commit:	`0e08605`
Status:	⚡️ Build in progress...

View logs

Copilot AI and others added 4 commits March 29, 2026 02:40

feat: migrate docs site from Docsify to VitePress

72aacdc

Agent-Logs-Url: https://github.com/insoxin/API/sessions/8496b6bc-948b-4992-8d5a-bd65fff1f2b7 Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

chore: remove built artifacts from repository and ignore dist output

6df762f

Agent-Logs-Url: https://github.com/insoxin/API/sessions/8496b6bc-948b-4992-8d5a-bd65fff1f2b7 Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

feat: switch homepage to coverpage content and normalize README images

26756bd

Agent-Logs-Url: https://github.com/insoxin/API/sessions/b57a0366-9697-42d9-9f62-44ca597c599a Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

chore: improve README image alt text accessibility

07b6126

Agent-Logs-Url: https://github.com/insoxin/API/sessions/b57a0366-9697-42d9-9f62-44ca597c599a Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

Copilot AI assigned Copilot and insoxin Mar 29, 2026

Copilot created this pull request from a session on behalf of insoxin March 29, 2026 02:52 View session

insoxin marked this pull request as ready for review March 29, 2026 02:54

Copilot AI review requested due to automatic review settings March 29, 2026 02:54

Copilot started reviewing on behalf of insoxin March 29, 2026 02:54 View session

Copilot started work on behalf of insoxin March 29, 2026 02:56 View session

chatgpt-codex-connector bot reviewed Mar 29, 2026

View reviewed changes

Copilot AI reviewed Mar 29, 2026

View reviewed changes

chore: remove legacy docsify environment files

667f444

Agent-Logs-Url: https://github.com/insoxin/API/sessions/02f46b2e-7093-484b-b7b4-9ac478f72a9f Co-authored-by: insoxin <19371836+insoxin@users.noreply.github.com>

vercel bot had a problem deploying to Preview March 29, 2026 02:57 Failure

Copilot finished work on behalf of insoxin March 29, 2026 03:00

Copilot AI requested a review from insoxin March 29, 2026 03:00

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use Markdown image syntax in README and make coverpage content the VitePress homepage#4

Use Markdown image syntax in README and make coverpage content the VitePress homepage#4
Copilot wants to merge 5 commits intomasterfrom
copilot/update-to-vitepress

Copilot AI commented Mar 29, 2026 •

edited

Loading

Uh oh!

vercel bot commented Mar 29, 2026 •

edited

Loading

Uh oh!

chatgpt-codex-connector bot left a comment

Uh oh!

chatgpt-codex-connector bot Mar 29, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 29, 2026

Uh oh!

Copilot AI Mar 29, 2026

Uh oh!

Copilot AI Mar 29, 2026

Uh oh!

Copilot AI Mar 29, 2026

Uh oh!

Copilot AI Mar 29, 2026

Uh oh!

cloudflare-workers-and-pages bot commented Mar 29, 2026 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

-  description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',
+  description: '姬长信API 一个基于多种编程语言并运行在Docker上开源免费不限制提供生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据的平台。',
+  base:
+    process.env.DOCS_BASE ||
+    (process.env.GITHUB_REPOSITORY
+      ? '/' + process.env.GITHUB_REPOSITORY.split('/')[1] + '/'
+      : '/'),

	[开始](#姬长信api-for-docker)
	[开始](#姬长信-api-for-docker-始于-2017)

Uh oh!

Conversation

Copilot AI commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

vercel bot commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

chatgpt-codex-connector bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

chatgpt-codex-connector bot Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

Uh oh!

cloudflare-workers-and-pages bot commented Mar 29, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Deploying api with Cloudflare Pages

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Mar 29, 2026 •

edited

Loading

vercel bot commented Mar 29, 2026 •

edited

Loading

cloudflare-workers-and-pages bot commented Mar 29, 2026 •

edited

Loading