Skip to content

feat(website): make LLM-friendly #94

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Danilqa merged 1 commit into from
Feb 14, 2026
Merged

feat(website): make LLM-friendly #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/docs/custom-adapter.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 5
description: How to create custom adapters for protocols other than HTTP or different frameworks like WebSockets.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/custom-adapter.mdx
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/getting-started.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 0
description: A step-by-step tutorial to set up file-based routing in Node.js with installation, first route, HTTP methods, and dynamic routes.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/getting-started.mdx
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/middlewares.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 5
description: Middleware functions that execute before API handlers for authentication, logging, error handling, with application-wide, route-specific, and folder-scoped support.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/middlewares.mdx
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/route-matching.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 2
description: Route matching patterns including direct, exact, catch-all, and optional catch-all matching with URL-to-file mapping rules.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/route-matching.mdx
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/usage-guide.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: How to initialize node-file-router with pure Node.js or Express, configuration options, and using object methods for HTTP verbs.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/usage-guide.mdx
---

Expand Down
1 change: 1 addition & 0 deletions website/docs/use-with-bun.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
sidebar_position: 1
description: How to set up and use node-file-router with Bun runtime for JavaScript and TypeScript development.
custom_edit_url: https://github.com/Danilqa/node-file-router/blob/main/website/docs/use-with-bun.mdx
---

Expand Down
25 changes: 24 additions & 1 deletion website/docusaurus.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,30 @@ const config = {
locales: ['en']
},

plugins: ['docusaurus-plugin-sass'],
plugins: [
'docusaurus-plugin-sass',
[
'docusaurus-plugin-llms',
{
generateLLMsTxt: true,
generateLLMsFullTxt: true,
generateMarkdownFiles: true,
docsDir: 'docs',
title: 'Node File Router',
description: 'A lightweight and fast file-based routing for Node.js. Works with any framework or pure Node.js HTTP server.',
excludeImports: true,
removeDuplicateHeadings: true,
includeOrder: [
'getting-started*',
'usage-guide*',
'use-with-bun*',
'route-matching*',
'middlewares*',
'custom-adapter*',
],
},
],
],

presets: [
[
Expand Down
10 changes: 6 additions & 4 deletions website/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,18 @@
"@docusaurus/core": "3.9.2",
"@docusaurus/preset-classic": "3.9.2",
"@mdx-js/react": "3.1.1",
"clsx": "2.1.0",
"clsx": "2.1.1",
"feed": "4.2.2",
Copy link
Copy Markdown

@cursor cursor Bot Feb 14, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unnecessary feed dependency added to production dependencies

Low Severity

The feed package was added as a direct production dependency, but it's never imported or used anywhere in the website source code. It's already available as a transitive dependency of @docusaurus/plugin-content-blog. This addition appears unrelated to the LLM-friendly feature and was likely committed accidentally during dependency updates.

Fix in Cursor Fix in Web

"prism-react-renderer": "2.4.1",
"react": "18.3.1",
"react-dom": "18.3.1"
},
"devDependencies": {
"@docusaurus/module-type-aliases": "3.0.0",
"@tsconfig/docusaurus": "2.0.3",
"@docusaurus/module-type-aliases": "3.9.2",
"@tsconfig/docusaurus": "2.0.9",
"docusaurus-plugin-llms": "0.3.0",
"docusaurus-plugin-sass": "0.2.6",
"typescript": "5.2.2"
"typescript": "5.9.3"
},
"browserslist": {
"production": [
Expand Down
Loading