Skip to content

Commit 3bf299a

Browse files
authored
feat: set up llms.txt (#84)
1 parent 7da0d26 commit 3bf299a

File tree

7 files changed

+1594
-625
lines changed

7 files changed

+1594
-625
lines changed

.gitignore

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,10 @@ dist
122122
# Stores VSCode versions used for testing VSCode extensions
123123
.vscode-test
124124

125+
# IDEs
126+
CLAUDE.local.md
127+
.claude/
128+
125129
# yarn v2
126130
.yarn/cache
127131
.yarn/unplugged

docs/.vitepress/config.mts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
import { defineConfig } from "vitepress";
2+
import llmstxt from "vitepress-plugin-llms";
3+
import { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";
24

35
/**
46
* Try your best not to have any sidebar page titles wrap to a 2nd line.
@@ -10,6 +12,16 @@ export default defineConfig({
1012
description:
1113
"The official documentation for how to get achievement, user, and game data from RetroAchievements.",
1214

15+
vite: {
16+
plugins: [llmstxt()],
17+
},
18+
19+
markdown: {
20+
config(md) {
21+
md.use(copyOrDownloadAsMarkdownButtons);
22+
},
23+
},
24+
1325
themeConfig: {
1426
siteTitle: "API",
1527
logo: "/logo.webp",
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<script setup>
2+
import { useRoute } from "vitepress";
3+
import CopyOrDownloadAsMarkdownButtons from "vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue";
4+
5+
const route = useRoute();
6+
7+
const shouldShow = () => {
8+
const path = route.path;
9+
return path !== "/" && path !== "/getting-started";
10+
};
11+
</script>
12+
13+
<template>
14+
<CopyOrDownloadAsMarkdownButtons v-if="shouldShow()" />
15+
</template>

docs/.vitepress/theme/index.js

Lines changed: 0 additions & 3 deletions
This file was deleted.

docs/.vitepress/theme/index.ts

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
import "./styles.css";
2+
3+
import DefaultTheme from "vitepress/theme";
4+
import type { Theme } from "vitepress";
5+
import ConditionalCopyButtons from "./ConditionalCopyButtons.vue";
6+
7+
export default {
8+
extends: DefaultTheme,
9+
enhanceApp({ app }) {
10+
app.component("CopyOrDownloadAsMarkdownButtons", ConditionalCopyButtons);
11+
},
12+
} satisfies Theme;

package.json

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,9 @@
1616
},
1717
"license": "MIT",
1818
"dependencies": {
19-
"vitepress": "^1.2.2",
20-
"vue": "3.3.13"
19+
"vitepress": "^1.6.4",
20+
"vitepress-plugin-llms": "^1.7.3",
21+
"vue": "3.5.18"
2122
},
2223
"devDependencies": {
2324
"husky": "8.0.3",

0 commit comments

Comments
 (0)