Skip to content

Commit

Permalink
Use only markdown links on docs ref (#449)
Browse files Browse the repository at this point in the history
  • Loading branch information
ntotten authored Dec 19, 2024
1 parent b02b277 commit 368e523
Show file tree
Hide file tree
Showing 9 changed files with 16 additions and 16 deletions.
2 changes: 1 addition & 1 deletion docs/pages/app-quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,4 +30,4 @@ If your OpenAPI file is in JSON format you can create an `openapi.json`. Set the
npm run dev
```

You now have a fully functional Zudoku site running on your local machine. Next, commit your changes to a source repository and [deploy the site](/docs/deployment) to your hosting provider or CDN.
You now have a fully functional Zudoku site running on your local machine. Next, commit your changes to a source repository and [deploy the site](./deployment.md) to your hosting provider or CDN.
2 changes: 1 addition & 1 deletion docs/pages/configuration/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: API Reference
sidebar_icon: square-library
---

The `apis` configuration setting in the [Zudoku Configuration](/docs/configuration/overview) file allows you to specify the OpenAPI document that you want to use to generate your API reference documentation.
The `apis` configuration setting in the [Zudoku Configuration](./overview.md) file allows you to specify the OpenAPI document that you want to use to generate your API reference documentation.

There are multiple ways to reference an API file in the configuration including using a URL or a local file path. The OpenAPI document can be in either JSON or YAML format.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/configuration/authentication.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ If you use a managed authentication service, such as Auth0, Clerk or OpenID you

## Configuration

To implement the authentication option for your site, add the `authentication` property to the [Zudoku Configuration](/docs/configuration/overview) file. The configuration is slightly different depending on the authentication provider you use.
To implement the authentication option for your site, add the `authentication` property to the [Zudoku Configuration](./overview.md) file. The configuration is slightly different depending on the authentication provider you use.

### Auth0

Expand Down
6 changes: 3 additions & 3 deletions docs/pages/configuration/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export default config;

### `apis`

There are multiple options for referencing your OpenAPI document. The example below uses a URL to an OpenAPI document, but you can also use a local file path. For full details on the options available, see the [API Reference](/docs/configuration/api-reference).
There are multiple options for referencing your OpenAPI document. The example below uses a URL to an OpenAPI document, but you can also use a local file path. For full details on the options available, see the [API Reference](./api-reference.md).

```json
{
Expand Down Expand Up @@ -124,7 +124,7 @@ Controls global page attributes across the site, including logos and the site ti

### `topNavigation`

Defines the links and headings for the top horizontal navigation that persists through every page on the site. For full details on the options available, see the [Navigation](/docs/configuration/navigation) page.
Defines the links and headings for the top horizontal navigation that persists through every page on the site. For full details on the options available, see the [Navigation](./navigation.mdx) page.

_Note: `topNavigation` will only display if there is more than one item in the navigation_

Expand All @@ -143,7 +143,7 @@ _Note: `topNavigation` will only display if there is more than one item in the n

### `sidebar`

Defines the sidebar navigation including top level categories and their sub pages. For full details on the options available, see the [Navigation](/docs/configuration/navigation) page.
Defines the sidebar navigation including top level categories and their sub pages. For full details on the options available, see the [Navigation](./navigation.mdx) page.

The example below uses a key of `documentation` which can be referenced as an `id` in `topNavigation`.

Expand Down
2 changes: 1 addition & 1 deletion docs/pages/configuration/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ To add search to your site you will need to copy some variables from your [Inkee
- Integration ID
- Organization ID

With these you can then configure the `search` option in [Zudoku Configuration](/docs/configuration/overview):
With these you can then configure the `search` option in [Zudoku Configuration](./overview.md):

```typescript
{
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/custom-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ export const LandingPage = () => {

## Configuration

In the [Zudoku Configuration](/docs/configuration/overview) you will need to add two things.
In the [Zudoku Configuration](./configuration/overview.md) you will need to add two things.

First, import the `<MyCustomPage />` component that you created.

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Zudoku comes in two flavors. Which one you choose depends on how quickly you wan

The two options are:

- **[Custom App (Recommended)](/docs/app-quickstart)**: Create a new React app using `create-zudoku-app` and customize it to your heart's content. This is the most flexible option and allows you to take full advantage of the Zudoku framework. [Open Quickstart](/docs/app-quickstart)
- **[Standalone HTML](/docs/html-quickstart)**: This is the quickest way to get started. Create a single HTML page and drop in the Zudoku script and stylesheet. [Open Quickstart](/docs/html-quickstart)
- **[Custom App (Recommended)](./app-quickstart.md)**: Create a new React app using `create-zudoku-app` and customize it to your heart's content. This is the most flexible option and allows you to take full advantage of the Zudoku framework. [Open Quickstart](./app-quickstart.md)
- **[Standalone HTML](./html-quickstart.md)**: This is the quickest way to get started. Create a single HTML page and drop in the Zudoku script and stylesheet. [Open Quickstart](./html-quickstart.md)

## Try Zudoku

Expand Down
4 changes: 2 additions & 2 deletions docs/pages/markdown/mdx.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Zudoku support MDX files for creating rich content pages. MDX is a markdown form

Zudoku supports the use of custom components in your MDX files. This allows you to create reusable components that can be used across multiple pages.

You can create a custom component in your project and reference it in the [Zudoku Configuration](/docs/configuration/overview) file.
You can create a custom component in your project and reference it in the [Zudoku Configuration](./overview.md) file.

For example, create the `<MyCustomComponent />` component in a file called `MyCustomComponent.tsx` in the `src` directory at the root of your project.

Expand All @@ -19,7 +19,7 @@ export default function MyCustomComponent() {
}
```

In [Zudoku Configuration](/docs/configuration/overview) you will need to import the component and add it to the `customComponents` option in the configuration.
In [Zudoku Configuration](./overview.md) you will need to import the component and add it to the `customComponents` option in the configuration.

```ts
import MyCustomComponent from "./src/MyCustomComponent";
Expand Down
8 changes: 4 additions & 4 deletions docs/pages/using-multiple-apis.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ sidebar_icon: file-stack

Zudoku supports creating documentation and API references for multiple APIs and can work with as many OpenAPI documents as you need.

In order to do this you will need to modify the [Zudoku Configuration](/docs/configuration/overview) file to include additional APIs.
In order to do this you will need to modify the [Zudoku Configuration](./configuration/overview.md) file to include additional APIs.

## Configuration

Using multiple APIs is a configuration setting that you can add in the [Zudoku Configuration](/docs/configuration/overview) file.
Using multiple APIs is a configuration setting that you can add in the [Zudoku Configuration](./configuration/overview.md) file.

### Step 1: Add all your APIs

First, create a new array in [Zudoku Configuration](/docs/configuration/overview) that lists each API you want to include as its own object:
First, create a new array in [Zudoku Configuration](./configuration/overview.md) that lists each API you want to include as its own object:

```typescript
const navigation = [
Expand All @@ -30,7 +30,7 @@ const navigation = [

### Step 2: Modify the config

Modify the [Zudoku Configuration](/docs/configuration/overview) file so that the `sidebar` and `apis` settings look the same as below:
Modify the [Zudoku Configuration](./configuration/overview.md) file so that the `sidebar` and `apis` settings look the same as below:

```typescript
import { type ZudokuConfig } from "zudoku";
Expand Down

0 comments on commit 368e523

Please sign in to comment.