From 538ed2d021bd904e1ee18471465fff8db53ca57c Mon Sep 17 00:00:00 2001 From: Alican Erdurmaz Date: Wed, 15 Apr 2026 14:53:33 +0300 Subject: [PATCH] feat(documentation): add llms.txt support via docusaurus-plugin-llms --- documentation/docusaurus.config.js | 46 ++++++++++++++++++++++++++++++ documentation/package.json | 1 + documentation/pnpm-lock.yaml | 23 +++++++++++++++ 3 files changed, 70 insertions(+) diff --git a/documentation/docusaurus.config.js b/documentation/docusaurus.config.js index 89fbdd32cf1b7..c5e45244b4440 100644 --- a/documentation/docusaurus.config.js +++ b/documentation/docusaurus.config.js @@ -203,6 +203,52 @@ const siteConfig = { }, }, ], + [ + "docusaurus-plugin-llms", + { + title: "Refine", + description: + "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.", + docsDir: "docs", + generateLLMsTxt: true, + generateLLMsFullTxt: true, + excludeImports: true, + removeDuplicateHeadings: true, + includeOrder: [ + "getting-started/**/*", + "guides-concepts/**/*", + "data/**/*", + "authentication/**/*", + "authorization/**/*", + "routing/**/*", + "realtime/**/*", + "notification/**/*", + "audit-logs/**/*", + "core/**/*", + "ui-integrations/**/*", + "packages/**/*", + "advanced-tutorials/**/*", + "examples/**/*", + "further-readings/**/*", + "migration-guide/**/*", + ], + ignoreFiles: ["partials/**/*"], + rootContent: `Refine is a meta-framework for building enterprise-grade, production-ready internal tools, admin panels, dashboards, and B2B applications using React. + +Key features: +- **Headless by design**: Works with any UI library (shadcn/ui, Ant Design, Material UI, Mantine, Chakra UI, or custom) +- **Data provider agnostic**: Connects to any REST, GraphQL, or custom API backend +- **Authentication & Authorization**: Built-in auth provider and access control (Casbin, Cerbos, Permify, etc.) +- **Routing**: Supports React Router, Next.js, and Remix +- **Realtime**: Live data updates with built-in support +- **i18n**: Internationalization support out of the box +- **Audit Logs**: Track data changes automatically + +Documentation: https://refine.dev/core/docs/ +GitHub: https://github.com/refinedev/refine +License: MIT`, + }, + ], ], themeConfig: { prism: { diff --git a/documentation/package.json b/documentation/package.json index 39fde2ce25d0f..18b72a1ac1182 100644 --- a/documentation/package.json +++ b/documentation/package.json @@ -100,6 +100,7 @@ "@types/react-dom": "^17.0.11", "@types/react-helmet": "^6.1.2", "cross-env": "^7.0.3", + "docusaurus-plugin-llms": "^0.3.1", "fast-xml-parser": "^5.4.1", "fs-extra": "^10.1.0", "jest": "^29.3.1", diff --git a/documentation/pnpm-lock.yaml b/documentation/pnpm-lock.yaml index 192c3e7e4b78e..10b4fc2c162c3 100644 --- a/documentation/pnpm-lock.yaml +++ b/documentation/pnpm-lock.yaml @@ -216,6 +216,9 @@ importers: cross-env: specifier: ^7.0.3 version: 7.0.3 + docusaurus-plugin-llms: + specifier: ^0.3.1 + version: 0.3.1(@docusaurus/core@2.4.0(@docusaurus/types@2.4.0(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2))(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2)(typescript@5.4.5)) fast-xml-parser: specifier: ^5.4.1 version: 5.4.1 @@ -3166,6 +3169,12 @@ packages: peerDependencies: '@docusaurus/core': ^2.0.0 + docusaurus-plugin-llms@0.3.1: + resolution: {integrity: sha512-2RsDC4czy1pt2kauIACOcLvSaGmjF3X0pgcVtL6fblzzZMgkasQJrOLN0pRur11j7rQkiaiCGR9NsU3mp4M8fg==} + engines: {node: '>=18.0'} + peerDependencies: + '@docusaurus/core': ^3.0.0 + dom-accessibility-api@0.5.16: resolution: {integrity: sha512-X7BJ2yElsnOJ30pZF4uIIDfBEVgF4XEBxL9Bxhy6dnrm5hkzqmsWHGTiHqRiITNhMyFLyAiWndIJP7Z1NTteDg==} @@ -6874,6 +6883,11 @@ packages: engines: {node: '>= 14'} hasBin: true + yaml@2.8.3: + resolution: {integrity: sha512-AvbaCLOO2Otw/lW5bmh9d/WEdcDFdQp2Z2ZUH3pX9U2ihyUY0nvLv7J6TrWowklRGPYbB/IuIMfYgxaCPg5Bpg==} + engines: {node: '>= 14.6'} + hasBin: true + yargs-parser@21.1.1: resolution: {integrity: sha512-tVpsJW7DdjecAiFpbIB1e3qxIQsE6NoPc5/eTdrbbIC4h0LVsWhnoa3g+m2HclBIujHzsxZ4VJVA+GUuc2/LBw==} engines: {node: '>=12'} @@ -10895,6 +10909,13 @@ snapshots: transitivePeerDependencies: - webpack + docusaurus-plugin-llms@0.3.1(@docusaurus/core@2.4.0(@docusaurus/types@2.4.0(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2))(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2)(typescript@5.4.5)): + dependencies: + '@docusaurus/core': 2.4.0(@docusaurus/types@2.4.0(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2))(@swc/core@1.5.5)(react-dom@17.0.2(react@17.0.2))(react@17.0.2)(typescript@5.4.5) + gray-matter: 4.0.3 + minimatch: 9.0.4 + yaml: 2.8.3 + dom-accessibility-api@0.5.16: {} dom-converter@0.2.0: @@ -15233,6 +15254,8 @@ snapshots: yaml@2.4.2: {} + yaml@2.8.3: {} + yargs-parser@21.1.1: {} yargs@17.7.2: