Skip to content

docs: add rspress-plugin-pdf-generator to README#193

Open
MaxtuneLee wants to merge 1 commit into
rstackjs:mainfrom
MaxtuneLee:patch-1
Open

docs: add rspress-plugin-pdf-generator to README#193
MaxtuneLee wants to merge 1 commit into
rstackjs:mainfrom
MaxtuneLee:patch-1

Conversation

@MaxtuneLee

Copy link
Copy Markdown

What

rspress-plugin-pdf-generator is an Rspress plugin designed to automatically render and compile documentation pages into PDF files during the site build process.

repo: https://github.com/MaxtuneLee/rspress-plugin-pdf-generator

Files touched

Add rspress-plugin-pdf-generator to README.

Add rspress-plugin-pdf-generator to README
@coderabbitai

coderabbitai Bot commented Jul 25, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

Added rspress-plugin-pdf-generator to the README’s “Rspress Plugins” list, describing its support for generating multilingual single-page or multi-page PDFs during the Rspress build process.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the README update adding rspress-plugin-pdf-generator.
Description check ✅ Passed The description matches the changeset by saying the plugin was added to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai 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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@README.md`:
- Line 362: Update the rspress-plugin-pdf-generator README description to
clearly state that it generates either one merged PDF or one PDF per Rspress
page, while preserving the supported multilingual output.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 9c46df3a-384d-4e1d-9c4d-6f320a08ac99

📥 Commits

Reviewing files that changed from the base of the PR and between 34a5ad4 and 9687c7f.

📒 Files selected for processing (1)
  • README.md

Comment thread README.md
- [rspress-plugin-auto-sidebar](https://github.com/buyfakett/rspress-plugin-auto-sidebar): Automatically generate the sidebar from the navbar configuration.
- [rspress-plugin-giscus](https://github.com/buyfakett/rspress-plugin-giscus): Integrate [giscus](https://github.com/giscus/giscus) into Rspress, a comment system powered by GitHub Discussions.
- [rspress-plugin-blog-list](https://github.com/buyfakett/rspress-plugin-blog-list): Integrate blog list into Rspress.
- [rspress-plugin-pdf-generator](https://github.com/MaxtuneLee/rspress-plugin-pdf-generator): Generates multi-language single-page or multi-page PDF documents from Rspress site during build process.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🎯 Functional Correctness | 🟡 Minor | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== README entry =="
sed -n '356,366p' README.md

echo
echo "== Search plugin references =="
rg -n "rspress-plugin-pdf-generator|single-page|multi-page|one PDF per page|merged PDF|pdf-generator" README.md documentation . 2>/dev/null | head -80 || true

Repository: rstackjs/awesome-rstack

Length of output: 1868


🌐 Web query:

MaxtuneLee rspress-plugin-pdf-generator README one merged PDF one PDF per page multilingual

💡 Result:

The rspress-plugin-pdf-generator, maintained by MaxtuneLee, is a plugin for the Rspress static site generator designed to export site content into PDF format during the build process [1]. According to the plugin's README, it supports the following key features: - Merged PDF: You can generate a single, combined PDF document for your site [1]. - Per-page PDF: The plugin also allows for generating individual PDF files for each page [1]. - Table of Contents: It supports building a table of contents within the generated PDF [1]. Regarding multilingual support, while the plugin is designed to work with Rspress—which has robust built-in support for internationalization (i18n) and multi-version documentation [2][3]—the plugin's ability to handle multilingual content typically follows the standard Rspress configuration where content is organized by language subdirectories (e.g., /en/, /zh/) [2]. Users should check the specific repository's documentation or configuration examples for any explicit i18n-specific settings in the plugin [1].

Citations:


Clarify the PDF mode wording.

“Single-page or multi-page PDF documents” is ambiguous; the plugin generates either one merged PDF or one PDF per page from the Rspress site, with multilingual output supported.

-- [rspress-plugin-pdf-generator](https://github.com/MaxtuneLee/rspress-plugin-pdf-generator): Generates multi-language single-page or multi-page PDF documents from Rspress site during build process.
+- [rspress-plugin-pdf-generator](https://github.com/MaxtuneLee/rspress-plugin-pdf-generator): Generates multilingual PDFs from an Rspress site during the build process, either as one merged document or one PDF per page.
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
- [rspress-plugin-pdf-generator](https://github.com/MaxtuneLee/rspress-plugin-pdf-generator): Generates multi-language single-page or multi-page PDF documents from Rspress site during build process.
[rspress-plugin-pdf-generator](https://github.com/MaxtuneLee/rspress-plugin-pdf-generator): Generates multilingual PDFs from an Rspress site during the build process, either as one merged document or one PDF per page.
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` at line 362, Update the rspress-plugin-pdf-generator README
description to clearly state that it generates either one merged PDF or one PDF
per Rspress page, while preserving the supported multilingual output.

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