Skip to content

docs: explain tag options of html.tags config#5573

Merged
chenjiahan merged 3 commits intomainfrom
tag_docs_0709
Jul 10, 2025
Merged

docs: explain tag options of html.tags config#5573
chenjiahan merged 3 commits intomainfrom
tag_docs_0709

Conversation

@chenjiahan
Copy link
Copy Markdown
Member

Summary

  • Add clarifications to the HtmlTag type
  • Include detailed examples for injecting tags, specifying attributes, defining innerHTML content, and using hash and publicPath options

Checklist

  • Tests updated (or not required).
  • Documentation updated (or not required).

Copilot AI review requested due to automatic review settings July 9, 2025 14:47
@netlify
Copy link
Copy Markdown

netlify bot commented Jul 9, 2025

Deploy Preview for rsbuild ready!

Name Link
🔨 Latest commit 3f2c87c
🔍 Latest deploy log https://app.netlify.com/projects/rsbuild/deploys/686e811c8edadc000871bd6f
😎 Deploy Preview https://deploy-preview-5573--rsbuild.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 75 (🔴 down 1 from production)
Accessibility: 97 (no change from production)
Best Practices: 100 (no change from production)
SEO: 100 (no change from production)
PWA: 60 (no change from production)
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify project configuration.

@chenjiahan chenjiahan changed the title docs: introducing tag options for html.tags docs: explain tag options of html.tags config Jul 9, 2025
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull Request Overview

This PR enhances the html.tags feature by clarifying its type options and providing detailed examples for tag injection, attributes, innerHTML content, and URL handling.

  • Add cross‐reference links to html.tags in hooks docs.
  • Enrich html.tags docs (Chinese and English) with multiple usage examples and expanded option descriptions.
  • Update TypeScript config comments to align with documentation changes.

Reviewed Changes

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

Show a summary per file
File Description
website/docs/zh/plugins/dev/hooks.mdx Added link to html.tags reference
website/docs/zh/config/html/tags.mdx Expanded Chinese docs with examples and detailed options
website/docs/en/plugins/dev/hooks.mdx Added link to html.tags reference
website/docs/en/config/html/tags.mdx Expanded English docs with examples and detailed options
packages/core/src/types/config.ts Updated JSDoc comments for hash and publicPath fields
Comments suppressed due to low confidence (1)

website/docs/en/config/html/tags.mdx:15

  • The English documentation contains Chinese headings and descriptions; these should be translated into English (e.g., 'Basic Example' instead of '基础示例').
## 基础示例

@chenjiahan chenjiahan merged commit 5d73138 into main Jul 10, 2025
14 checks passed
@chenjiahan chenjiahan deleted the tag_docs_0709 branch July 10, 2025 00:03
@chenjiahan chenjiahan mentioned this pull request Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants