From 6d01555120fac952dc36512142095169f09e3618 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Lehoczky=20Zolt=C3=A1n?= Date: Sun, 23 Jul 2023 09:40:53 +0200 Subject: [PATCH] docs: fix rule summary, and edit links --- docs/.vitepress/config.ts | 5 +++-- docs/.vitepress/constants.ts | 1 + docs/.vitepress/rulesForSidebar.ts | 3 ++- 3 files changed, 6 insertions(+), 3 deletions(-) create mode 100644 docs/.vitepress/constants.ts diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index f1421ef0..26cf6a59 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,11 +1,12 @@ import { defineConfig } from "vitepress"; import { rules } from "./rulesForSidebar"; import { description, version } from "../../package.json"; +import { BASE_URL } from "./constants"; // https://vitepress.dev/reference/site-config export default defineConfig({ title: "eslint-plugin-vuejs-a11y", - base: "/eslint-plugin-vuejs-accessibility/", + base: BASE_URL, description, head: [ [ @@ -66,7 +67,7 @@ export default defineConfig({ editLink: { pattern: - "https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/edit/master/docs/:path" + "https://github.com/vue-a11y/eslint-plugin-vuejs-accessibility/edit/main/docs/:path" }, socialLinks: [ diff --git a/docs/.vitepress/constants.ts b/docs/.vitepress/constants.ts new file mode 100644 index 00000000..985f157b --- /dev/null +++ b/docs/.vitepress/constants.ts @@ -0,0 +1 @@ +export const BASE_URL = "/eslint-plugin-vuejs-accessibility/"; diff --git a/docs/.vitepress/rulesForSidebar.ts b/docs/.vitepress/rulesForSidebar.ts index ca78e3ef..eb968810 100644 --- a/docs/.vitepress/rulesForSidebar.ts +++ b/docs/.vitepress/rulesForSidebar.ts @@ -1,5 +1,6 @@ import { join, parse } from "node:path"; import { Dirent, readdirSync } from "node:fs"; +import { BASE_URL } from "./constants"; export const rules = getRulesForSideBar(); @@ -29,6 +30,6 @@ function fileNameWithoutExtension(file: Dirent) { function ruleToSidebarItem(ruleName: string) { return { text: ruleName, - link: `/rules/${ruleName}` + link: `${BASE_URL}rules/${ruleName}` }; }