Skip to content

feat(rspress-custom-theme): add custom icons documentation#36

Merged
SoonIter merged 3 commits intomainfrom
syt/rspress-custom-theme
Mar 23, 2026
Merged

feat(rspress-custom-theme): add custom icons documentation#36
SoonIter merged 3 commits intomainfrom
syt/rspress-custom-theme

Conversation

@SoonIter
Copy link
Copy Markdown
Member

Summary

  • Add custom icons section to rspress-custom-theme skill with three usage patterns: inline SVG component, SVGR import, and URL string
  • Include full list of 27 available built-in icons and SvgWrapper usage example
  • Add icon re-export row to the decision flow table and icons reference URL

Test plan

  • Verify the icon re-export examples follow the correct theme/index.tsx pattern
  • Confirm all 27 icon names match the Rspress source

Copilot AI review requested due to automatic review settings March 23, 2026 10:56
@gemini-code-assist
Copy link
Copy Markdown
Contributor

Summary of Changes

Hello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the rspress-custom-theme skill by introducing dedicated documentation for customizing Rspress's built-in icons. It provides clear guidance and examples for developers to replace default icons with custom ones using various techniques, ensuring greater flexibility in theme design without requiring complex component ejection.

Highlights

  • Custom Icons Documentation Added: Comprehensive documentation for customizing Rspress built-in icons was added to the rspress-custom-theme skill.
  • Icon Usage Patterns Detailed: Three methods for icon replacement are detailed: inline SVG components, SVGR imports, and URL strings.
  • Built-in Icons and SvgWrapper: A complete list of 27 available built-in Rspress icons and an example of SvgWrapper usage were included.
  • Decision Flow Table Updated: The Rspress theme customization decision flow table was updated to explicitly mention icon re-export as an approach.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Add icon re-export examples covering inline SVG, SVGR imports, and URL
strings, along with the full list of 27 available built-in icons.
@SoonIter SoonIter force-pushed the syt/rspress-custom-theme branch from 9b45753 to dc560bb Compare March 23, 2026 10:57
Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

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

Code Review

This pull request introduces a new skill, rspress-custom-theme, with detailed documentation on customizing Rspress themes, including a new section on icons. The changes are well-structured and add valuable information.

My review identified one high-severity issue based on the repository's style guide. The guide requires that adding a new skill must be accompanied by an update to the main README.md to ensure discoverability. This update is missing. I have also suggested a minor clarification in the documentation to improve accuracy. After addressing the README.md update, the PR will be ready.

I am having trouble creating individual review comments. Click here to see my feedback.

skills/rspress-custom-theme/SKILL.md (1-4)

high

According to the repository's style guide, when a new skill is added, the root README.md file must be updated to include it. This pull request adds the rspress-custom-theme skill, but README.md has not been modified.

Please update README.md to:

  1. Add rspress-custom-theme to the Table of Contents under Rspress Skills.
  2. Add a new section for rspress-custom-theme under the "Rspress Skills" heading, including the skill name, installation command, and a brief description.

This is required for discoverability and to adhere to the project's contribution guidelines.

References
  1. The repository style guide (lines 5, 6, 9, 11) mandates that when a new skill is added, the README.md file must be updated to include a new section for the skill and the table of contents must be synchronized. Failure to do so is considered a high-severity issue. (link)

skills/rspress-custom-theme/SKILL.md (185)

medium

The documentation states there are 27 built-in icons, and this list contains exactly 27. The etc. at the end is misleading as it implies the list is incomplete. For clarity, it's better to remove it to indicate that this is the full list.

**Available icons**: `IconArrowDown`, `IconArrowRight`, `IconClose`, `IconCopy`, `IconDeprecated`, `IconDown`, `IconEdit`, `IconEmpty`, `IconExperimental`, `IconExternalLink`, `IconFile`, `IconGithub`, `IconGitlab`, `IconHeader`, `IconJump`, `IconLink`, `IconLoading`, `IconMenu`, `IconMoon`, `IconScrollToTop`, `IconSearch`, `IconSmallMenu`, `IconSuccess`, `IconSun`, `IconTitle`, `IconWrap`, `IconWrapped`

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

Adds and expands documentation for the rspress-custom-theme skill to help users choose the right Rspress v2 customization approach, with new reference pages and an expanded section on custom icon replacement via theme/index.tsx re-exports.

Changes:

  • Added three new reference docs: CSS variables, Layout slots, and component ejection workflows.
  • Expanded SKILL.md with a decision flow, theme/index.tsx patterns, and a new “Custom Icons” section.
  • Updated the repository dictionary to include rgba.

Reviewed changes

Copilot reviewed 1 out of 1 changed files in this pull request and generated 3 comments.

Show a summary per file
File Description
skills/rspress-custom-theme/references/layout-slots.md New reference doc enumerating Layout slots and usage patterns.
skills/rspress-custom-theme/references/eject-components.md New reference doc explaining rspress eject, available components, and override patterns.
skills/rspress-custom-theme/references/css-variables.md New reference doc listing theme CSS variables and defaults + a quick-start snippet.
skills/rspress-custom-theme/SKILL.md Main skill doc with decision flow, theme/index.tsx guidance, and custom icons documentation.
scripts/dictionary.txt Adds rgba to spelling dictionary.
Comments suppressed due to low confidence (1)

skills/rspress-custom-theme/SKILL.md:16

  • “Level 1A” is referenced here and below, but there’s no Level 1A defined in the decision flow (only Level 1 with two options). Consider renaming these references to something like “Level 1 (Option A)” / “Level 1 with theme/index.tsx” to avoid confusion.
2. **Pick the right level** using the decision flow below
3. **Set up `theme/index.tsx`** if needed (Levels 1A, 3, 4 all need it)
4. **Implement** following the patterns in this skill and reference files
5. **Verify** the user's Rspress version is v2 (imports use `@rspress/core/*` not `rspress/*`)

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

- Add rspress-custom-theme to README.md for discoverability
- Remove misleading "etc." from complete icons list
- Add React type import to Icon type snippet
@SoonIter SoonIter requested a review from Timeless0911 March 23, 2026 11:04
@SoonIter SoonIter merged commit 2da8862 into main Mar 23, 2026
4 checks passed
@SoonIter SoonIter deleted the syt/rspress-custom-theme branch March 23, 2026 11:07
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.

3 participants