Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,10 @@ dist
# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# IDEs
CLAUDE.local.md
.claude/

# yarn v2
.yarn/cache
.yarn/unplugged
Expand Down
12 changes: 12 additions & 0 deletions docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
import { defineConfig } from "vitepress";
import llmstxt from "vitepress-plugin-llms";
import { copyOrDownloadAsMarkdownButtons } from "vitepress-plugin-llms";

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

vite: {
plugins: [llmstxt()],
},

markdown: {
config(md) {
md.use(copyOrDownloadAsMarkdownButtons);
},
},

themeConfig: {
siteTitle: "API",
logo: "/logo.webp",
Expand Down
15 changes: 15 additions & 0 deletions docs/.vitepress/theme/ConditionalCopyButtons.vue
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<script setup>
import { useRoute } from "vitepress";
import CopyOrDownloadAsMarkdownButtons from "vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue";

const route = useRoute();

const shouldShow = () => {
const path = route.path;
return path !== "/" && path !== "/getting-started";
};
</script>

<template>
<CopyOrDownloadAsMarkdownButtons v-if="shouldShow()" />
</template>
3 changes: 0 additions & 3 deletions docs/.vitepress/theme/index.js

This file was deleted.

12 changes: 12 additions & 0 deletions docs/.vitepress/theme/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import "./styles.css";

import DefaultTheme from "vitepress/theme";
import type { Theme } from "vitepress";
import ConditionalCopyButtons from "./ConditionalCopyButtons.vue";

export default {
extends: DefaultTheme,
enhanceApp({ app }) {
app.component("CopyOrDownloadAsMarkdownButtons", ConditionalCopyButtons);
},
} satisfies Theme;
5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,9 @@
},
"license": "MIT",
"dependencies": {
"vitepress": "^1.2.2",
"vue": "3.3.13"
"vitepress": "^1.6.4",
"vitepress-plugin-llms": "^1.7.3",
"vue": "3.5.18"
},
"devDependencies": {
"husky": "8.0.3",
Expand Down
Loading