Skip to content
/ API Public template

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Copilot wants to merge 5 commits into
base: master
Choose a base branch
from
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
72aacdc
feat: migrate docs site from Docsify to VitePress
Copilot Mar 29, 2026
6df762f
chore: remove built artifacts from repository and ignore dist output
Copilot Mar 29, 2026
26756bd
feat: switch homepage to coverpage content and normalize README images
Copilot Mar 29, 2026
07b6126
chore: improve README image alt text accessibility
Copilot Mar 29, 2026
667f444
chore: remove legacy docsify environment files
Copilot Mar 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 23 additions & 11 deletions .github/workflows/pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,22 +21,34 @@ concurrency:
cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: 20
cache: npm
- name: Install dependencies
run: npm ci
- name: Build VitePress site
run: npm run docs:build
- name: Setup Pages
uses: actions/configure-pages@v2
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: '.'
path: .vitepress/dist

deploy:
needs: build
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
node_modules/
*.log
.vitepress/dist/
66 changes: 66 additions & 0 deletions .vitepress/config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import { defineConfig } from 'vitepress'

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

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
ignoreDeadLinks: true,
markdown: {
html: false
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector bot Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge 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 👍 / 👎.

Copy link

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.
},
themeConfig: {
nav: [
{
text: 'Translations',
items: [
{ text: '🇨🇳 中文', link: '/' },
{ text: '🇬🇧 English', link: '/' }
]
}
],
search: {
provider: 'local'
},
sidebar: [
{ text: 'GY.公益中国', link: '/公益中国' },
{ text: '0. 壁纸模块', link: '/壁纸模块' },
{ text: '1. 新闻模块', link: '/新闻模块' },
{ text: '2. 视频模块', link: '/视频模块' },
{ text: '3. 笑话段子轻松一刻', link: '/笑话段子轻松一刻' },
{ text: '4. 图片相册接口', link: '/图片相册接口' },
{ text: '5. 天气预报', link: '/天气预报' },
{ text: '6. Web 前端开发资讯日报', link: '/前端开发资讯日报' },
{ text: '7. Web 知乎日报数据', link: '/知乎日报数据' },
{ text: '8. 豆瓣热播电影', link: '/豆瓣热播电影' },
{ text: '9. 招聘信息', link: '/招聘信息' },
{ text: '10. 开发杂类', link: '/开发杂类' },
{ text: '11. 电子商务', link: '/电子商务' },
{ text: '12. 人工智能', link: '/人工智能' },
{ text: '13. 生活服务', link: '/生活服务' },
{ text: '14. 实名鉴权', link: '/实名鉴权' },
{ text: '15. 网络信息', link: '/网络信息' },
{ text: '16. 新闻资讯', link: '/新闻资讯' },
{ text: '17. 知识问答', link: '/知识问答' }
],
socialLinks: [{ icon: 'github', link: 'https://github.com/insoxin/API' }]
},
head: [
[
'script',
{
type: 'text/javascript',
charset: 'UTF-8',
src: 'https://fastly.jsdelivr.net/gh/insoxin/API@master/js/v1.js',
'exte-id': '548',
'data-size': '36x140',
'data-color': '#FF7119',
'data-show': '1'
}
],
[
'script',
{},
"var _hmt = _hmt || [];(function(){var hm=document.createElement('script');hm.src='https://hm.baidu.com/hm.js?fda02e31e77cd366043a929e3043c19f';var s=document.getElementsByTagName('script')[0];s.parentNode.insertBefore(hm,s);})();"
]
]
})
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@ API For Docker 是一个基于多种编程语言的开放 API 平台，免费、
###### 统计


<img src="https://api.isoyu.com/CloudflareTrafficCard/cf_svg.php?period=7d" width="400" height="40" alt="svg" ><a>
![7-day Cloudflare traffic statistics](https://api.isoyu.com/CloudflareTrafficCard/cf_svg.php?period=7d)

<img src="https://api.isoyu.com/CloudflareTrafficCard/cf_svg.php?period=30d" width="400" height="40" alt="svg" ><a>
![30-day Cloudflare traffic statistics](https://api.isoyu.com/CloudflareTrafficCard/cf_svg.php?period=30d)


---
Expand Down
Empty file removed docs/.nojekyll
View file
Open in desktop
Empty file.
1 change: 0 additions & 1 deletion docs/README.md
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions docs/_coverpage.md
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion docs/docsify.min.js
View file
Open in desktop

This file was deleted.

70 changes: 0 additions & 70 deletions docs/index.html
View file
Open in desktop

This file was deleted.

83 changes: 0 additions & 83 deletions docs/sw.js
View file
Open in desktop

This file was deleted.

88 changes: 0 additions & 88 deletions index.html
View file
Open in desktop

This file was deleted.

9 changes: 9 additions & 0 deletions index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# 姬长信 API For Docker <small>始于 2017</small>

Comment on lines +1 to +2
Copy link

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 uses AI. Check for mistakes.
> 姬长信 API For Docker 是一个基于多种编程语言的开源 API 平台，免费且不限调用，覆盖生活常用、出行服务、开发工具、金融服务、通讯服务和公益大数据等场景。

* 须知：姬长信 API 将记录你的域名、使用流量、调用次数等重要信息并存储六个月，如介意请勿使用。[统计信息](https://api.isoyu.com) 管理员邮箱：admin@isoyu.com
* 条款：姬长信 API 拥有所有运行权，在某些特定情况下有权禁止你的网站调用。
* 禁止用于违法、商业用途，不接受定制功能性捐助！
[GitHub](https://github.com/insoxin/API/)
[开始](#姬长信api-for-docker)
Copy link

Copilot AI Mar 29, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[开始](#姬长信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 uses AI. Check for mistakes.
Loading