docusaurus-plugin-llms 0.1.0 → 0.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +13 -37
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,33 +1,9 @@
|
|
|
1
1
|
# 📜 docusaurus-plugin-llms
|
|
2
2
|
|
|
3
|
-
A Docusaurus plugin for generating LLM-friendly documentation following the [
|
|
3
|
+
A Docusaurus plugin for generating LLM-friendly documentation following the [llmstxt standard](https://llmstxt.org/).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
7
|
-
There are two ways to use this plugin:
|
|
8
|
-
|
|
9
|
-
### 1. Direct Integration (Simplest Method)
|
|
10
|
-
|
|
11
|
-
For quick integration, create a plugin file directly in your Docusaurus project:
|
|
12
|
-
|
|
13
|
-
```bash
|
|
14
|
-
mkdir -p src/plugins/llms
|
|
15
|
-
```
|
|
16
|
-
|
|
17
|
-
Then create a file at `src/plugins/llms/index.js` with the plugin code. Finally, add it to your `docusaurus.config.js`:
|
|
18
|
-
|
|
19
|
-
```js
|
|
20
|
-
module.exports = {
|
|
21
|
-
// ... your existing Docusaurus config
|
|
22
|
-
plugins: [
|
|
23
|
-
require('./src/plugins/llms'),
|
|
24
|
-
// ... your other plugins
|
|
25
|
-
],
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
### 2. As a Package (Not Yet Published)
|
|
30
|
-
|
|
31
7
|
```bash
|
|
32
8
|
npm install docusaurus-plugin-llms --save-dev
|
|
33
9
|
```
|
|
@@ -72,17 +48,17 @@ module.exports = {
|
|
|
72
48
|
|
|
73
49
|
### Available Options
|
|
74
50
|
|
|
75
|
-
| Option
|
|
76
|
-
|
|
77
|
-
| `generateLLMsTxt`
|
|
78
|
-
| `generateLLMsFullTxt` | boolean
|
|
79
|
-
| `docsDir`
|
|
80
|
-
| `ignoreFiles`
|
|
81
|
-
| `title`
|
|
82
|
-
| `description`
|
|
83
|
-
| `llmsTxtFilename`
|
|
84
|
-
| `llmsFullTxtFilename` | string
|
|
85
|
-
| `includeBlog`
|
|
51
|
+
| Option | Type | Default | Description |
|
|
52
|
+
|-----------------------|----------|-------------------|----------------------------------------------|
|
|
53
|
+
| `generateLLMsTxt` | boolean | `true` | Whether to generate the links file |
|
|
54
|
+
| `generateLLMsFullTxt` | boolean | `true` | Whether to generate the full content file |
|
|
55
|
+
| `docsDir` | string | `'docs'` | Base directory for documentation files |
|
|
56
|
+
| `ignoreFiles` | string[] | `[]` | Array of glob patterns for files to ignore |
|
|
57
|
+
| `title` | string | Site title | Custom title to use in generated files |
|
|
58
|
+
| `description` | string | Site tagline | Custom description to use in generated files |
|
|
59
|
+
| `llmsTxtFilename` | string | `'llms.txt'` | Custom filename for the links file |
|
|
60
|
+
| `llmsFullTxtFilename` | string | `'llms-full.txt'` | Custom filename for the full content file |
|
|
61
|
+
| `includeBlog` | boolean | `false` | Whether to include blog content |
|
|
86
62
|
|
|
87
63
|
## How It Works
|
|
88
64
|
|
|
@@ -91,7 +67,7 @@ This plugin automatically generates the following files during the build process
|
|
|
91
67
|
- **llms.txt**: Contains links to all sections of your documentation
|
|
92
68
|
- **llms-full.txt**: Contains all documentation content in a single file
|
|
93
69
|
|
|
94
|
-
These files follow the [
|
|
70
|
+
These files follow the [llmstxt standard](https://llmstxt.org/), making your documentation optimized for use with Large Language Models (LLMs).
|
|
95
71
|
|
|
96
72
|
## Features
|
|
97
73
|
|