fix: unable to use non-GitHub repo in editLink

close vuejs#694
kecrily · Jun 2, 2022 · ed291fc · ed291fc
1 parent 6e53be6
commit ed291fc
Show file tree

Hide file tree

Showing 3 changed files with 63 additions and 1 deletion.
diff --git a/docs/config/theme-configs.md b/docs/config/theme-configs.md
@@ -188,6 +188,61 @@ export interface Footer {
 }
 ```
 
+## editLink
+
+- Type: `EditLink`
+
+Edit link configuration. You can then customize git repo link and display text.
+
+```ts
+export default {
+  themeConfig: {
+    editLink: {
+      domain: 'github.com'
+      repo: 'vuejs/vitepress',
+      branch: 'next',
+      dir: 'docs',
+      text: 'Edit this page on GitHub'
+    },
+  }
+}
+```
+
+```ts
+export interface EditLink {
+  /** 
+   * Domain of git repo
+   * 
+   * @example 'github.com' or 'https://github.com'
+   */
+  domain?: string
+  /**
+   * Repo of the site.
+   *
+   * @example 'vuejs/docs'
+   */
+  repo: string
+  /**
+   * Branch of the repo.
+   *
+   * @default 'main'
+   */
+  branch?: string
+  /**
+   * If your docs are not at the root of the repo.
+   *
+   * @example 'docs'
+   */
+  dir?: string
+  /**
+   * Custom text for edit link.
+   *
+   * @default 'Edit this page'
+   */
+  text?: string
+}
+```
+
 ## lastUpdatedText
 
 - Type: `string`

diff --git a/src/client/theme-default/composables/edit-link.ts b/src/client/theme-default/composables/edit-link.ts
@@ -6,7 +6,7 @@ export function useEditLink() {
 
   return computed(() => {
     const url = [
-      'https://github.com',
+      `https://${theme.value.editLink?.domain || 'github.com'}`,
       theme.value.editLink?.repo || '???',
       'edit',
       theme.value.editLink?.branch || 'main',

diff --git a/types/default-theme.d.ts b/types/default-theme.d.ts
@@ -119,6 +119,13 @@ export namespace DefaultTheme {
   // edit link -----------------------------------------------------------------
 
   export interface EditLink {
+    /**
+     * Domain of git repo
+     *
+     * @example 'github.com' or 'https://github.com'
+     */
+    domain?: string
+
     /**
      * Repo of the site.
      *