Skip to content

Commit d115d37

Browse files
authored
docs(llms): Update docusaurus llms plugins to get improved sections (#500)
1 parent 9b34f3d commit d115d37

File tree

3 files changed

+19
-26
lines changed

3 files changed

+19
-26
lines changed

docs/docusaurus.config.ts

Lines changed: 7 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -111,16 +111,14 @@ const config: Config = {
111111
[
112112
'@signalwire/docusaurus-plugin-llms-txt',
113113
{
114-
generate: {
115-
enableMarkdownFiles: true,
114+
llmsTxt: {
115+
siteDescription:
116+
'CedarJS is the full-stack web framework designed to help you ' +
117+
'grow from side project to startup. CedarJS features an end-to-' +
118+
'end development workflow that weaves together the best parts of ' +
119+
'React, GraphQL, Prisma, TypeScript, Vitest, and Storybook.',
116120
enableLlmsFullTxt: true,
117-
},
118-
include: {
119-
includeBlog: false,
120-
includeVersionedDocs: false,
121121
excludeRoutes: ['/search'],
122-
},
123-
structure: {
124122
sections: [
125123
{
126124
id: 'introduction',
@@ -208,16 +206,11 @@ const config: Config = {
208206
routes: [{ route: '/docs/upgrade-guides/**' }],
209207
},
210208
],
211-
siteTitle: 'CedarJS',
212-
siteDescription:
213-
'CedarJS is the full-stack web framework designed to help you ' +
214-
'grow from side project to startup. CedarJS features an end-to-' +
215-
'end development workflow that weaves together the best parts of ' +
216-
'React, GraphQL, Prisma, TypeScript, Vitest, and Storybook.',
217209
},
218210
ui: {
219211
copyPageContent: true,
220212
},
213+
logLevel: 1,
221214
} satisfies LlmsTxtPluginOptions,
222215
],
223216
],

docs/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@
3030
"@docusaurus/theme-common": "3.8.1",
3131
"@easyops-cn/docusaurus-search-local": "^0.49.2",
3232
"@mdx-js/react": "3.0.1",
33-
"@signalwire/docusaurus-plugin-llms-txt": "2.0.0-alpha.2",
34-
"@signalwire/docusaurus-theme-llms-txt": "1.0.0-alpha.3",
33+
"@signalwire/docusaurus-plugin-llms-txt": "2.0.0-alpha.5",
34+
"@signalwire/docusaurus-theme-llms-txt": "1.0.0-alpha.6",
3535
"clsx": "2.1.1",
3636
"prism-react-renderer": "2.4.1",
3737
"react": "18.2.0",

docs/yarn.lock

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3439,9 +3439,9 @@ __metadata:
34393439
languageName: node
34403440
linkType: hard
34413441

3442-
"@signalwire/docusaurus-plugin-llms-txt@npm:2.0.0-alpha.2":
3443-
version: 2.0.0-alpha.2
3444-
resolution: "@signalwire/docusaurus-plugin-llms-txt@npm:2.0.0-alpha.2"
3442+
"@signalwire/docusaurus-plugin-llms-txt@npm:2.0.0-alpha.5":
3443+
version: 2.0.0-alpha.5
3444+
resolution: "@signalwire/docusaurus-plugin-llms-txt@npm:2.0.0-alpha.5"
34453445
dependencies:
34463446
fs-extra: "npm:^11.0.0"
34473447
hast-util-select: "npm:^6.0.4"
@@ -3457,13 +3457,13 @@ __metadata:
34573457
unist-util-visit: "npm:^5"
34583458
peerDependencies:
34593459
"@docusaurus/core": ^3.0.0
3460-
checksum: 10c0/8c9fe930b96c0e42815720db216105d7717a587a7afc32782ee2c6ba9d50670cd88e363421617cb10fd36f2b28fd0d5bdf3275ce53fbde201036b2855b455caf
3460+
checksum: 10c0/227a030147eff3b88c3117d61b6e88e4b64a65ee19856c4add76d3ddc25c9d0c0211a2f83cbdda138aa9f60622d552681632a70864b316b812d698af7d9d2378
34613461
languageName: node
34623462
linkType: hard
34633463

3464-
"@signalwire/docusaurus-theme-llms-txt@npm:1.0.0-alpha.3":
3465-
version: 1.0.0-alpha.3
3466-
resolution: "@signalwire/docusaurus-theme-llms-txt@npm:1.0.0-alpha.3"
3464+
"@signalwire/docusaurus-theme-llms-txt@npm:1.0.0-alpha.6":
3465+
version: 1.0.0-alpha.6
3466+
resolution: "@signalwire/docusaurus-theme-llms-txt@npm:1.0.0-alpha.6"
34673467
dependencies:
34683468
"@docusaurus/core": "npm:^3.0.0"
34693469
"@docusaurus/theme-common": "npm:^3.0.0"
@@ -3472,7 +3472,7 @@ __metadata:
34723472
peerDependencies:
34733473
react: ^18.0.0
34743474
react-dom: ^18.0.0
3475-
checksum: 10c0/c9c1a7269534ace05e0a68384b3d581d50d3370c05ec7feca81b9aa856fd16faf9d7c071b3403eb9bfd45efd24332d92016af18e08162475891653eb8486ad88
3475+
checksum: 10c0/17ee9337d2b65fd4b0c0a2aa615ff5629f16cf4d156978a9ee7648c9103b3465dd7983b343cc380f2cc946ed525f776361f5f8868c75e147734bc380034e530c
34763476
languageName: node
34773477
linkType: hard
34783478

@@ -6101,8 +6101,8 @@ __metadata:
61016101
"@docusaurus/types": "npm:3.8.1"
61026102
"@easyops-cn/docusaurus-search-local": "npm:^0.49.2"
61036103
"@mdx-js/react": "npm:3.0.1"
6104-
"@signalwire/docusaurus-plugin-llms-txt": "npm:2.0.0-alpha.2"
6105-
"@signalwire/docusaurus-theme-llms-txt": "npm:1.0.0-alpha.3"
6104+
"@signalwire/docusaurus-plugin-llms-txt": "npm:2.0.0-alpha.5"
6105+
"@signalwire/docusaurus-theme-llms-txt": "npm:1.0.0-alpha.6"
61066106
"@types/react": "npm:^18.2.55"
61076107
clsx: "npm:2.1.1"
61086108
prism-react-renderer: "npm:2.4.1"

0 commit comments

Comments
 (0)