Skip to content

Commit 883b7c2

Browse files
feat(website): configure llms plugin
1 parent 4f8c177 commit 883b7c2

File tree

3 files changed

+37
-8
lines changed

3 files changed

+37
-8
lines changed

packages/website/docusaurus.config.ts

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,21 @@ const config: Config = {
9494
},
9595
},
9696
],
97+
[
98+
'docusaurus-plugin-llms',
99+
{
100+
// source: https://github.com/rachfop/docusaurus-plugin-llms?tab=readme-ov-file#configuration-options
101+
generateLLMsTxt: true,
102+
generateLLMsFullTxt: true,
103+
docsDir: 'docs',
104+
// ignoreFiles: ['dataviz/*', 'content/*', 'patterns/*'],
105+
title: 'Elastic UI documentation',
106+
description: 'Complete reference documentation for Elastic UI',
107+
includeBlog: false,
108+
// includeOrder: ['getting-started/*', 'components/*', 'utilities/*'],
109+
// includeUnmatchedLast: false,
110+
},
111+
],
97112
],
98113

99114
themeConfig: {

packages/website/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
"clsx": "^2.0.0",
3838
"cross-env": "^7.0.3",
3939
"docusaurus-lunr-search": "patch:docusaurus-lunr-search@npm%3A3.6.1#~/.yarn/patches/docusaurus-lunr-search-npm-3.6.1-9688befeb3.patch",
40+
"docusaurus-plugin-llms": "^0.1.4",
4041
"hast-util-is-element": "1.1.0",
4142
"lodash": "^4.17.21",
4243
"moment": "^2.30.1",

yarn.lock

Lines changed: 21 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7284,6 +7284,7 @@ __metadata:
72847284
cross-env: "npm:^7.0.3"
72857285
cspell: "npm:^8.17.5"
72867286
docusaurus-lunr-search: "patch:docusaurus-lunr-search@npm%3A3.6.1#~/.yarn/patches/docusaurus-lunr-search-npm-3.6.1-9688befeb3.patch"
7287+
docusaurus-plugin-llms: "npm:^0.1.4"
72877288
hast-util-is-element: "npm:1.1.0"
72887289
lodash: "npm:^4.17.21"
72897290
moment: "npm:^2.30.1"
@@ -19554,6 +19555,18 @@ __metadata:
1955419555
languageName: node
1955519556
linkType: hard
1955619557

19558+
"docusaurus-plugin-llms@npm:^0.1.4":
19559+
version: 0.1.4
19560+
resolution: "docusaurus-plugin-llms@npm:0.1.4"
19561+
dependencies:
19562+
gray-matter: "npm:^4.0.3"
19563+
minimatch: "npm:^9.0.3"
19564+
peerDependencies:
19565+
"@docusaurus/core": ^3.0.0
19566+
checksum: 10c0/af82adefb388ddf6b567ee0b22005089784d772c50f04e46ed20d6c9811d2cc268478820c784f7afd6a74c0a08f06ee06f9c591f9fdf82d3c1aa567045774608
19567+
languageName: node
19568+
linkType: hard
19569+
1955719570
"dom-accessibility-api@npm:^0.5.6, dom-accessibility-api@npm:^0.5.9":
1955819571
version: 0.5.14
1955919572
resolution: "dom-accessibility-api@npm:0.5.14"
@@ -29736,21 +29749,21 @@ __metadata:
2973629749
languageName: node
2973729750
linkType: hard
2973829751

29739-
"minimatch@npm:^9.0.4":
29740-
version: 9.0.4
29741-
resolution: "minimatch@npm:9.0.4"
29752+
"minimatch@npm:^9.0.3, minimatch@npm:^9.0.5":
29753+
version: 9.0.5
29754+
resolution: "minimatch@npm:9.0.5"
2974229755
dependencies:
2974329756
brace-expansion: "npm:^2.0.1"
29744-
checksum: 10c0/2c16f21f50e64922864e560ff97c587d15fd491f65d92a677a344e970fe62aafdbeafe648965fa96d33c061b4d0eabfe0213466203dd793367e7f28658cf6414
29757+
checksum: 10c0/de96cf5e35bdf0eab3e2c853522f98ffbe9a36c37797778d2665231ec1f20a9447a7e567cb640901f89e4daaa95ae5d70c65a9e8aa2bb0019b6facbc3c0575ed
2974529758
languageName: node
2974629759
linkType: hard
2974729760

29748-
"minimatch@npm:^9.0.5":
29749-
version: 9.0.5
29750-
resolution: "minimatch@npm:9.0.5"
29761+
"minimatch@npm:^9.0.4":
29762+
version: 9.0.4
29763+
resolution: "minimatch@npm:9.0.4"
2975129764
dependencies:
2975229765
brace-expansion: "npm:^2.0.1"
29753-
checksum: 10c0/de96cf5e35bdf0eab3e2c853522f98ffbe9a36c37797778d2665231ec1f20a9447a7e567cb640901f89e4daaa95ae5d70c65a9e8aa2bb0019b6facbc3c0575ed
29766+
checksum: 10c0/2c16f21f50e64922864e560ff97c587d15fd491f65d92a677a344e970fe62aafdbeafe648965fa96d33c061b4d0eabfe0213466203dd793367e7f28658cf6414
2975429767
languageName: node
2975529768
linkType: hard
2975629769

0 commit comments

Comments
 (0)