Skip to content

docs(readme): 更新头图与主题排版展示 - #34

Merged
geekjourneyx merged 1 commit into
mainfrom
docs/readme-layout-showcase-20261014
Oct 14, 2026
Merged

geekjourneyx merged 1 commit into
mainfrom
docs/readme-layout-showcase-20261014

Conversation

@geekjourneyx

@geekjourneyx geekjourneyx commented Oct 14, 2026 •

Copy link
Copy Markdown
Owner

README 顶部原来使用 3D 动画,未直接呈现文章排版结果。本次使用已选定的文章主视觉作为唯一头图,并在「排版效果」展示同一篇文章的不同主题样式。

  • 图5 → assets/readme-layout-showcase.png;项目定位与一句用途说明置于头图前。
  • 图6 → assets/theme-showcase/theme-comparison-showcase.png;原有三张单主题样稿保留在折叠区,画廊入口保持可访问。
  • 图片原样保留,提供描述性 alt;说明图中文字为排版示例,服务范围链接至专业 API。图7不加入 README。

验证:git diff --check 通过;README 所有本地图片引用均存在;两张新增图片可完整解码、尺寸均为 1600×900,与上传原文件逐字节一致;定位顺序与折叠标签检查通过。远端 compare 确认改动仅 README 和两张图片。

本地 make quality-gates 在版本一致性检查通过(3.8.0)后,因缺少 Go/gofmt 工具链中止。随后 GitHub CI 已成功执行完整统一质量门禁(格式、go vet、golangci-lint、测试、npm 包检查与 release-check):运行 38562440038,结论 SUCCESS。

本次不修改 CLI、API、主题渲染、版本或安装路径;没有合并或部署。

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 14, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-14T12:19:03.703142Z 2228b41 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 2228b41b44

ℹ️ 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".

Comment thread README.md

写 Markdown,生成公众号排版,制作封面和文章配图,预览校验后推送草稿箱。

<img src="assets/readme-layout-showcase.png" alt="md2wechat 排版展示:文章主视觉与高级排版模块示例" width="720" />

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Correct the 59-module claim in the hero image

The newly embedded hero prominently says “高级排版 59 模块,” but the repository’s counting contract distinguishes 59 recommended syntax names mapped from 83 scenarios from the 65 total render-layer capabilities. This contradicts the precise wording elsewhere in the README and will misstate the catalog to readers who rely on the new visual; regenerate the image with “59 个推荐语法” or otherwise preserve that distinction.

AGENTS.md reference: AGENTS.md:L50-L56

Useful? React with 👍 / 👎.

Comment thread README.md

写 Markdown,生成公众号排版,制作封面和文章配图,预览校验后推送草稿箱。

<img src="assets/readme-layout-showcase.png" alt="md2wechat 排版展示:文章主视觉与高级排版模块示例" width="720" />

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Compress the showcase assets before embedding them

This adds a 1.63 MB PNG here and another 1.73 MB PNG in the layout section, even though both are displayed at only 720 px wide. GitHub must still fetch the full assets, increasing the README’s referenced local-media payload from roughly 1.7 MB to 4.4 MB and making the project landing page substantially slower on constrained connections; resize and encode these screenshots as optimized WebP/AVIF or smaller PNGs before embedding them.

Useful? React with 👍 / 👎.

@geekjourneyx
geekjourneyx merged commit 8ee56af into main Oct 14, 2026
1 check passed
@geekjourneyx
geekjourneyx deleted the docs/readme-layout-showcase-20261014 branch October 14, 2026 12:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant