Enhance @llmtxt packages and improve SPA support#5
Merged
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| }; | ||
|
|
||
| function normalizeBaseUrl(baseUrl: string): string { | ||
| return baseUrl.replace(/\/+$/, ''); |
Comment on lines
+41
to
+45
| return html | ||
| .replace(/<script[\s\S]*?<\/script>/gi, '') | ||
| .replace(/<style[\s\S]*?<\/style>/gi, '') | ||
| .replace(/<\/(p|div|section|article|h\d|li|ul|ol|br)\s*>/gi, '\n') | ||
| .replace(/<[^>]+>/g, '') |
Comment on lines
+41
to
+43
| return html | ||
| .replace(/<script[\s\S]*?<\/script>/gi, '') | ||
| .replace(/<style[\s\S]*?<\/style>/gi, '') |
Comment on lines
+41
to
+42
| return html | ||
| .replace(/<script[\s\S]*?<\/script>/gi, '') |
Comment on lines
+41
to
+47
| return html | ||
| .replace(/<script[\s\S]*?<\/script>/gi, '') | ||
| .replace(/<style[\s\S]*?<\/style>/gi, '') | ||
| .replace(/<\/(p|div|section|article|h\d|li|ul|ol|br)\s*>/gi, '\n') | ||
| .replace(/<[^>]+>/g, '') | ||
| .replace(/ /g, ' ') | ||
| .replace(/&/g, '&') |
|
|
||
| function stripHtmlToText(html: string): string { | ||
| return html | ||
| .replace(/<script[\s\S]*?<\/script>/gi, '') |
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (8)
📒 Files selected for processing (55)
📝 WalkthroughWalkthroughThis PR performs a comprehensive namespace migration from ChangesNamespace migration and React package launch
Estimated code review effort🎯 4 (Complex) | ⏱️ ~50 minutes Possibly related PRs
✨ Finishing Touches📝 Generate docstrings
🧪 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This pull request introduces a new example React application demonstrating how to use
@llmtxt/reactto generate AI-friendly documentation for SPAs, and updates documentation and configuration to use the correct package naming (@llmtxt/*) throughout the repository. It also adds a sample.npmrc.examplefor npm publishing, and improves the main and example READMEs with clearer instructions and new sections for React integration.Major additions and improvements:
React Example App:
examples/my-react-app/— a comprehensive Vite + React + React Router demo showcasing@llmtxt/reactintegration, including 11+ pages, a documentation generator script, and full setup instructions. [1] [2] [3] [4] [5] [6]Documentation and package naming:
@llmstxt/*to@llmtxt/*in the mainREADME.md, example READMEs, and code snippets to ensure consistency and correct usage. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10] [11] [12]New documentation sections:
README.md, with step-by-step instructions for integrating@llmtxt/reactin SPAs.Configuration and publishing:
.npmrc.examplefor npm registry and token configuration, aiding package publishing and local development.Other improvements:
.gitignoreand ESLint config in the new React example for best practices and developer experience. [1] [2]These changes provide a clear example for React SPA users, ensure correct package references, and improve the onboarding and publishing experience.<!--
😀 Wonderful! Thank you for opening a pull request.
Please fill in the information below to expedite the review
and (hopefully) merge of your change.
-->
Description of change
Pull-Request Checklist
mainbranchnpm run lintpasses with this changenpm run testpasses with this changeFixes #0000Summary by CodeRabbit
Release Notes
New Features
@llmtxt/reactpackage for generating documentation files from React single-page applications at build time without requiring a backend.Documentation
@llmtxtpackage namespace.Chores