Skip to content

Commit d9889ee

Browse files
feat(documentation): add llms.txt support via docusaurus-plugin-llms (#7399)
1 parent fb3ae57 commit d9889ee

3 files changed

Lines changed: 70 additions & 0 deletions

File tree

documentation/docusaurus.config.js

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -203,6 +203,52 @@ const siteConfig = {
203203
},
204204
},
205205
],
206+
[
207+
"docusaurus-plugin-llms",
208+
{
209+
title: "Refine",
210+
description:
211+
"Refine is an open-source, headless React framework for building enterprise-grade internal tools, admin panels, dashboards, and B2B applications. It provides industry-standard solutions for critical concerns like authentication, access control, routing, networking, state management, and i18n.",
212+
docsDir: "docs",
213+
generateLLMsTxt: true,
214+
generateLLMsFullTxt: true,
215+
excludeImports: true,
216+
removeDuplicateHeadings: true,
217+
includeOrder: [
218+
"getting-started/**/*",
219+
"guides-concepts/**/*",
220+
"data/**/*",
221+
"authentication/**/*",
222+
"authorization/**/*",
223+
"routing/**/*",
224+
"realtime/**/*",
225+
"notification/**/*",
226+
"audit-logs/**/*",
227+
"core/**/*",
228+
"ui-integrations/**/*",
229+
"packages/**/*",
230+
"advanced-tutorials/**/*",
231+
"examples/**/*",
232+
"further-readings/**/*",
233+
"migration-guide/**/*",
234+
],
235+
ignoreFiles: ["partials/**/*"],
236+
rootContent: `Refine is a meta-framework for building enterprise-grade, production-ready internal tools, admin panels, dashboards, and B2B applications using React.
237+
238+
Key features:
239+
- **Headless by design**: Works with any UI library (shadcn/ui, Ant Design, Material UI, Mantine, Chakra UI, or custom)
240+
- **Data provider agnostic**: Connects to any REST, GraphQL, or custom API backend
241+
- **Authentication & Authorization**: Built-in auth provider and access control (Casbin, Cerbos, Permify, etc.)
242+
- **Routing**: Supports React Router, Next.js, and Remix
243+
- **Realtime**: Live data updates with built-in support
244+
- **i18n**: Internationalization support out of the box
245+
- **Audit Logs**: Track data changes automatically
246+
247+
Documentation: https://refine.dev/core/docs/
248+
GitHub: https://github.com/refinedev/refine
249+
License: MIT`,
250+
},
251+
],
206252
],
207253
themeConfig: {
208254
prism: {

documentation/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,7 @@
100100
"@types/react-dom": "^17.0.11",
101101
"@types/react-helmet": "^6.1.2",
102102
"cross-env": "^7.0.3",
103+
"docusaurus-plugin-llms": "^0.3.1",
103104
"fast-xml-parser": "^5.4.1",
104105
"fs-extra": "^10.1.0",
105106
"jest": "^29.3.1",

documentation/pnpm-lock.yaml

Lines changed: 23 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)