Fix docs build (#1447)

Author: drwpow

.gitignore

@@ -1,5 +1,4 @@
 .DS_Store
-.astro
 dist
 node_modules
 

README.md

@@ -23,6 +23,6 @@ Contributions are appreciated and welcome! See the appropriate guide for each pa
 ## ♥️ Thanks
 
 - Thanks to [dozens of lovely, smart contributors](https://github.com/drwpow/openapi-typescript/graphs/contributors) that made this library possible
-- Thanks to [Astro](https://astro.build/) for the docs site
+- Thanks to [Vitepress](https://vitepress.dev/) for the docs site
 - Thanks to [Cloudflare Pages](https://pages.cloudflare.com/) for docs site hosting
 - Thanks to [Algolia](https://www.algolia.com/) for the docs site search

docs/.vitepress/config.ts

@@ -6,6 +6,8 @@ export default defineConfig({
   title: "OpenAPI TS",
   description: "Consume OpenAPI 3.0 & 3.1 schemas in TypeScript",
   cleanUrls: true,
+  srcExclude: ["**/*/CONTRIBUTRING.md", "**/*/README.md"],
+  ignoreDeadLinks: [/CODE_OF_CONDUCT/],
   /** @see https://vitepress.dev/reference/default-theme-config */
   themeConfig: {
     siteTitle: false,

docs/6.x/advanced.md

@@ -11,7 +11,7 @@ Advanced usage and various topics.
 
 Fetching data can be done simply and safely using an **automatically-typed fetch wrapper**:
 
-- [openapi-fetch](./openapi-fetch) (recommended)
+- [openapi-fetch](/openapi-fetch/) (recommended)
 - [openapi-typescript-fetch](https://www.npmjs.com/package/openapi-typescript-fetch) by [@ajaishankar](https://github.com/ajaishankar)
 
 ::: tip
@@ -78,7 +78,7 @@ describe("My API test", () => {
 
 :::
 
-_Note: this example uses a vanilla `fetch()` function, but any fetch wrapper—including [openapi-fetch](/openapi-fetch)—could be dropped in instead without any changes._
+_Note: this example uses a vanilla `fetch()` function, but any fetch wrapper—including [openapi-fetch](/openapi-fetch/)—could be dropped in instead without any changes._
 
 And the magic that produces this would live in a `test/utils.ts` file that can be copy + pasted where desired (hidden for simplicity):
 

docs/6.x/introduction.md

@@ -76,7 +76,7 @@ type ErrorResponse =
 
 From here, you can use these types for any of the following (but not limited to):
 
-- Using an OpenAPI-supported fetch client (like [openapi-fetch](/openapi-fetch))
+- Using an OpenAPI-supported fetch client (like [openapi-fetch](/openapi-fetch/))
 - Asserting types for other API requestBodies and responses
 - Building core business logic based on API types
 - Validating mock test data is up-to-date with the current schema

docs/README.md

@@ -1,6 +1,6 @@
 # openapi-typescript Docs
 
-Docs site powered by [Astro](https://github.com/withastro/astro), a modern static site generator.
+Docs site powered by [Vitepress](https://vitepress.dev/), an ergonomic docs site template powered by Vite.
 
 Lives at [https://openapi-ts.pages.dev](https://openapi-ts.pages.dev).
 
@@ -13,13 +13,11 @@ pnpm 1
 pnpm run dev
 ```
 
-That will launch the docs site at `http://localhost:3000`.
+That will launch the docs site at `http://localhost:5173`.
 
 ## Editing
 
-All content lives in the [content/](./src/content) directory, in `.md` files that should be familiar to edit to most.
-
-For the non-markdown bits, please see the [Astro Documentation](https://docs.astro.build/en/getting-started/).
+All content lives in `.md` files that feature normal Markdown content [with powerful Vitepress extensions](https://vitepress.dev/guide/markdown).
 
 ## Contributing
 

docs/advanced.md

@@ -11,7 +11,7 @@ Advanced usage and various topics.
 
 Fetching data can be done simply and safely using an **automatically-typed fetch wrapper**:
 
-- [openapi-fetch](./openapi-fetch) (recommended)
+- [openapi-fetch](/openapi-fetch/) (recommended)
 - [openapi-typescript-fetch](https://www.npmjs.com/package/openapi-typescript-fetch) by [@ajaishankar](https://github.com/ajaishankar)
 
 ::: tip
@@ -89,7 +89,7 @@ describe("My API test", () => {
 
 :::
 
-_Note: this example uses a vanilla `fetch()` function, but any fetch wrapper—including [openapi-fetch](/openapi-fetch)—could be dropped in instead without any changes._
+_Note: this example uses a vanilla `fetch()` function, but any fetch wrapper—including [openapi-fetch](/openapi-fetch/)—could be dropped in instead without any changes._
 
 And the magic that produces this would live in a `test/utils.ts` file that can be copy + pasted where desired (hidden for simplicity):
 

docs/introduction.md

@@ -70,7 +70,7 @@ type ErrorResponse =
 
 From here, you can use these types for any of the following (but not limited to):
 
-- Using an OpenAPI-supported fetch client (like [openapi-fetch](/openapi-fetch))
+- Using an OpenAPI-supported fetch client (like [openapi-fetch](/openapi-fetch/))
 - Asserting types for other API requestBodies and responses
 - Building core business logic based on API types
 - Validating mock test data is up-to-date with the current schema