Skip to content

Commit 19f4343

Browse files
authored
docs: Add llms.txt (#531)
This change adds the [docusaurus-plugin-llms](https://www.npmjs.com/package/docusaurus-plugin-llms) plugin which adds `/llms.txt` and `/llms-full.txt` to the docs. See https://llmstxt.org/ The output of the plugin is not perfect but should be satisfactory for now. <img width="876" height="475" alt="CleanShot 2025-08-13 at 12 38 00" src="https://github.com/user-attachments/assets/26423ca0-8d96-4d66-8fd3-165f2553ebbc" />
1 parent 9ae9d05 commit 19f4343

3 files changed

Lines changed: 44 additions & 0 deletions

File tree

docs/docusaurus.config.ts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,19 @@ const config: Config = {
6868
],
6969
},
7070
],
71+
[
72+
"docusaurus-plugin-llms",
73+
{
74+
title: "Santa Documentation",
75+
description:
76+
"Documentation for Santa, a binary and file access authorization system for macOS from North Pole Security",
77+
generateLLMsTxt: true,
78+
generateLLMsFullTxt: true,
79+
docsDir: "docs",
80+
excludeImports: true,
81+
removeDuplicateHeadings: true,
82+
},
83+
],
7184
],
7285

7386
// Even if you don't use internationalization, you can use this field to set

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
"@tailwindcss/postcss": "^4.1.3",
3131
"class-variance-authority": "^0.7.1",
3232
"clsx": "^2.0.0",
33+
"docusaurus-plugin-llms": "^0.1.5",
3334
"lucide-react": "^0.487.0",
3435
"postcss": "^8.5.3",
3536
"prism-react-renderer": "^2.3.0",

docs/pnpm-lock.yaml

Lines changed: 30 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)