docs: add rspress-plugin-pdf-generator to README#193
Conversation
Add rspress-plugin-pdf-generator to README
📝 WalkthroughWalkthroughAdded 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
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
| - [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. |
There was a problem hiding this comment.
🎯 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 || trueRepository: 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:
- 1: https://github.com/maxtunelee/rspress-plugin-pdf-generator/
- 2: https://rspress.rs/guide/basic/multi-version
- 3: https://rspress.rs/guide/start/getting-started.md
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.
| - [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.
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.