change!: rename package to vitepress-openapi (#70)

enzonotario · Oct 6, 2024 · 317a6b8 · 317a6b8
1 parent c9fa203
commit 317a6b8
Show file tree

Hide file tree

Showing 80 changed files with 154 additions and 155 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.yml b/.github/ISSUE_TEMPLATE/1-bug-report.yml
@@ -1,5 +1,5 @@
 name: "🐛 Bug Report"
-description: Report a bug found while using the theme.
+description: Report a bug found while using vitepress-openapi.
 labels: ["Type: Bug", "Status: Triage"]
 body:
  - type: textarea
@@ -20,7 +20,7 @@ body:
  id: reproduction
  attributes:
  label: Reproduction
- description: Please provide a link via [vitepress-theme-openapi-starter StackBlitz](https://stackblitz.com/fork/github/enzonotario/vitepress-theme-openapi-starter?file=public/openapi.json) or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label.
+ description: Please provide a link via [vitepress-openapi-starter StackBlitz](https://stackblitz.com/fork/github/enzonotario/vitepress-openapi-starter?file=public/openapi.json) or a link to a repo that can reproduce the problem you ran into. A [minimal reproduction](https://stackoverflow.com/help/minimal-reproducible-example) is required ([Why?](https://antfu.me/posts/why-reproductions-are-required)). If a report is vague (e.g. just a generic error message) and has no reproduction, it will receive a "needs reproduction" label.
  placeholder: Reproduction URL
  - type: textarea
  id: reproduction-steps

diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.yml b/.github/ISSUE_TEMPLATE/2-feature-request.yml
@@ -1,5 +1,5 @@
 name: "✨ Feature Request"
-description: Suggest a feature or enhancement to the theme.
+description: Suggest a feature or enhancement to vitepress-openapi.
 labels: ["Type: Idea"]
 body:
  - type: textarea
@@ -26,4 +26,4 @@ body:
  id: other
  attributes:
  label: Other information
- placeholder: Any other details?
+ placeholder: Any other details?
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ Generate VitePress API Documentation from OpenAPI Specification.
 
 ## Documentation
 
-To get started, check out the [documentation](https://vitepress-theme-openapi.vercel.app/).
+To get started, check out the [documentation](https://vitepress-openapi.vercel.app/).
 
 ## License
 

diff --git a/components.json b/components.json
@@ -12,6 +12,6 @@
  "framework": "vite",
  "aliases": {
  "components": "src/components",
- "utils": "vitepress-theme-openapi/lib/utils"
+ "utils": "vitepress-openapi/lib/utils"
  }
 }
diff --git a/dev/.vitepress/config.ts b/dev/.vitepress/config.ts
@@ -1,5 +1,5 @@
 import { resolve } from 'node:path'
-import { useSidebar } from 'vitepress-theme-openapi'
+import { useSidebar } from 'vitepress-openapi'
 import { defineConfigWithTheme } from 'vitepress'
 import spec from '../../docs/public/openapi.json' assert { type: 'json' }
 
@@ -9,10 +9,10 @@ const sidebar = useSidebar({
 })
 
 export default defineConfigWithTheme({
- title: 'vitepress-theme-openapi',
- description: 'OpenAPI theme for VitePress',
+ title: 'vitepress-openapi',
+ description: 'Generate VitePress API Documentation from OpenAPI specs.',
  themeConfig: {
- repo: 'https://github.com/enzonotario/vitepress-theme-openapi',
+ repo: 'https://github.com/enzonotario/vitepress-openapi',
  outline: [1, 3],
  sidebar: [
  ...sidebar.generateSidebarGroups(),
@@ -71,7 +71,7 @@ export default defineConfigWithTheme({
  vite: {
  resolve: {
  alias: {
- 'vitepress-theme-openapi': resolve(__dirname, '../../src'),
+ 'vitepress-openapi': resolve(__dirname, '../../src'),
  },
  dedupe: ['vue'], // avoid error when using dependencies that also use Vue
  },

diff --git a/dev/.vitepress/theme/index.ts b/dev/.vitepress/theme/index.ts
@@ -1,4 +1,4 @@
-import { theme, useOpenapi, useTheme } from 'vitepress-theme-openapi'
+import { theme, useOpenapi, useTheme } from 'vitepress-openapi'
 import DefaultTheme from 'vitepress/theme'
 import spec from '../../../docs/public/openapi.json' assert {type: 'json'}
 

diff --git a/dev/argentinadatos/index.md b/dev/argentinadatos/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/criptoya-argentina/index.md b/dev/criptoya-argentina/index.md
@@ -1,13 +1,13 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">
 import { onUnmounted } from 'vue'
 import { useRoute, useData } from 'vitepress'
-import { useTheme } from 'vitepress-theme-openapi'
+import { useTheme } from 'vitepress-openapi'
 import spec from '../../docs/public/openapi-criptoya-argentina.json'
 
 const route = useRoute()

diff --git a/dev/custom-slots.md b/dev/custom-slots.md
@@ -1,12 +1,12 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">
 import { useData } from 'vitepress'
-import { useOpenapi } from 'vitepress-theme-openapi'
+import { useOpenapi } from 'vitepress-openapi'
 
 const { isDark } = useData()
 

diff --git a/dev/index.md b/dev/index.md
@@ -1,3 +1,3 @@
-# vitepress-theme-openapi
+# vitepress-openapi
 
-OpenAPI theme for VitePress.
+VitePress OpenAPI.
diff --git a/dev/multiple-specs/buyMuseumTickets.md b/dev/multiple-specs/buyMuseumTickets.md
@@ -1,12 +1,12 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">
 import { useRoute, useData } from 'vitepress'
-import { useOpenapi } from 'vitepress-theme-openapi'
+import { useOpenapi } from 'vitepress-openapi'
 import spec from '../../docs/public/openapi.json'
 import specV2 from '../../docs/public/openapi-v2.json'
 

diff --git a/dev/one-page.md b/dev/one-page.md
@@ -1,7 +1,7 @@
 ---
 aside: true
 outline: [1, 2]
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/operations/[operationId].md b/dev/operations/[operationId].md
@@ -1,12 +1,12 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">
 import { useRoute, useData } from 'vitepress'
-import { useOpenapi, useTheme } from 'vitepress-theme-openapi'
+import { useOpenapi, useTheme } from 'vitepress-openapi'
 
 const route = useRoute()
 

diff --git a/dev/operations/[operationId].paths.js b/dev/operations/[operationId].paths.js
@@ -1,4 +1,4 @@
-import { OpenApi } from 'vitepress-theme-openapi'
+import { OpenApi } from 'vitepress-openapi'
 import spec from '../../docs/public/openapi.json' assert { type: 'json' }
 
 export default {
@@ -9,7 +9,7 @@ export default {
  return {
  params: {
  operationId,
- pageTitle: `${summary} - vitepress-theme-openapi`,
+ pageTitle: `${summary} - vitepress-openapi`,
  },
  }
  })

diff --git a/dev/plant-store/index.md b/dev/plant-store/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/response-statuses/index.md b/dev/response-statuses/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/response-types/index.md b/dev/response-types/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/scalar-galaxy/index.md b/dev/scalar-galaxy/index.md
@@ -1,7 +1,7 @@
 ---
 aside: true
 outline: [1, 2]
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/dev/schemas/index.md b/dev/schemas/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts
@@ -1,15 +1,15 @@
 import { resolve } from 'node:path'
 import spec from '../public/openapi.json' assert { type: 'json' }
 import { defineConfigWithTheme } from 'vitepress'
-import { useSidebar } from 'vitepress-theme-openapi'
+import { useSidebar } from 'vitepress-openapi'
 
 const sidebar = useSidebar({ spec })
 
 const gaId = 'G-ELG8ZW19X4'
 
 export default defineConfigWithTheme({
- title: 'VitePress Theme OpenAPI',
- description: 'A VitePress theme for OpenAPI',
+ title: 'VitePress OpenAPI',
+ description: 'Generate VitePress API Documentation from OpenAPI specs.',
  themeConfig: {
  nav: [],
 
@@ -105,15 +105,15 @@ export default defineConfigWithTheme({
  ],
 
  socialLinks: [
- { icon: 'github', link: 'https://github.com/enzonotario/vitepress-theme-openapi' },
+ { icon: 'github', link: 'https://github.com/enzonotario/vitepress-openapi' },
  ],
 
  outline: {
  level: [1, 3],
  },
 
  footer: {
- message: 'Released under the <a href="https://github.com/enzonotario/vitepress-theme-openapi/blob/main/LICENSE">MIT License</a>.',
+ message: 'Released under the <a href="https://github.com/enzonotario/vitepress-openapi/blob/main/LICENSE">MIT License</a>.',
  copyright: 'Copyright © 2023-present <a href="https://enzonotario.me">Enzo Notario</a>',
  },
  },
@@ -134,7 +134,7 @@ export default defineConfigWithTheme({
  vite: {
  resolve: {
  alias: {
- 'vitepress-theme-openapi': resolve(__dirname, '../../'),
+ 'vitepress-openapi': resolve(__dirname, '../../'),
  },
  },
  },

diff --git a/docs/.vitepress/theme/index.ts b/docs/.vitepress/theme/index.ts
@@ -1,7 +1,7 @@
-import { theme, useOpenapi, useTheme } from 'vitepress-theme-openapi'
+import { theme, useOpenapi, useTheme } from 'vitepress-openapi'
 import DefaultTheme from 'vitepress/theme'
 import spec from '../../public/openapi.json' assert {type: 'json'}
-import 'vitepress-theme-openapi/dist/style.css'
+import 'vitepress-openapi/dist/style.css'
 
 export default {
  ...DefaultTheme,

diff --git a/docs/composables/usePlayground.md b/docs/composables/usePlayground.md
@@ -5,7 +5,7 @@ The `usePlayground` composable provides functions to manage the Playground.
 You can use the `usePlayground` composable to configure the Playground in your `.vitepress/theme/index.js` file, or in any `.md` page/file.
 
 ```ts
-import { usePlayground } from 'vitepress-theme-openapi'
+import { usePlayground } from 'vitepress-openapi'
 
 export default {
  async enhanceApp({ app, router, siteData }) {

diff --git a/docs/composables/useTheme.md b/docs/composables/useTheme.md
@@ -5,7 +5,7 @@ The `useTheme` composable provides functions to configure the theme.
 You can use the `useTheme` composable to configure the theme in your `.vitepress/theme/index.js` file, or in any `.md` page/file.
 
 ```ts
-import { useTheme } from 'vitepress-theme-openapi'
+import { useTheme } from 'vitepress-openapi'
 
 export default {
  async enhanceApp({app, router, siteData}) {

diff --git a/docs/example/one-page.md b/docs/example/one-page.md
@@ -1,7 +1,7 @@
 ---
 aside: true
 outline: [1, 2]
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/docs/example/operations/[operationId].md b/docs/example/operations/[operationId].md
@@ -1,12 +1,12 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">
 import { useRoute, useData } from 'vitepress'
-import { useOpenapi, useTheme } from 'vitepress-theme-openapi'
+import { useOpenapi, useTheme } from 'vitepress-openapi'
 
 const route = useRoute()
 

diff --git a/docs/example/operations/[operationId].paths.js b/docs/example/operations/[operationId].paths.js
@@ -1,4 +1,4 @@
-import { useOpenapi, httpVerbs } from 'vitepress-theme-openapi'
+import { useOpenapi, httpVerbs } from 'vitepress-openapi'
 import spec from '../../public/openapi.json' assert { type: 'json' }
 
 export default {
@@ -18,7 +18,7 @@ export default {
  return {
  params: {
  operationId,
- pageTitle: `${summary} - vitepress-theme-openapi`,
+ pageTitle: `${summary} - vitepress-openapi`,
  },
  }
  })

diff --git a/docs/example/response-statuses/index.md b/docs/example/response-statuses/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/docs/example/response-types/index.md b/docs/example/response-types/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">

diff --git a/docs/example/schemas/index.md b/docs/example/schemas/index.md
@@ -1,7 +1,7 @@
 ---
 aside: false
 outline: false
-title: vitepress-theme-openapi
+title: vitepress-openapi
 ---
 
 <script setup lang="ts">