Skip to content

Commit

Permalink
docs: fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrobertlloyd committed Nov 17, 2024
1 parent 65cbafc commit 131ff2b
Show file tree
Hide file tree
Showing 13 changed files with 21 additions and 21 deletions.
2 changes: 1 addition & 1 deletion docs/api/add-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# `Indiekit.addEndpoint`

An [endpoint](../../concepts.md#endpoint) adds Express routes to an Indiekit server. Routes can add new pages to the web interface, or provide API endpoints that support IndieWeb (or other) protocols or APIs.
An [endpoint](../concepts.md#endpoint) adds Express routes to an Indiekit server. Routes can add new pages to the web interface, or provide API endpoints that support IndieWeb (or other) protocols or APIs.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/api/add-post-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# `Indiekit.addPostType`

A [post type](../../concepts.md#post-type) defines fields for creating and editing different post (or content) types, either using Indiekit or via third-party Micropub clients.
A [post type](../concepts.md#post-type) defines fields for creating and editing different post (or content) types, either using Indiekit or via third-party Micropub clients.

## Syntax

Expand Down
8 changes: 4 additions & 4 deletions docs/api/add-preset.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# `Indiekit.addPreset`

A [publication preset](../../concepts.md#publication-preset) can set default storage locations and URL formats for [post types](../../concepts.md#post-type), and post templates for a given publication, be that a static site generator, content management system or other publishing software.
A [publication preset](../concepts.md#publication-preset) can set default storage locations and URL formats for [post types](../concepts.md#post-type), and post templates for a given publication, be that a static site generator, content management system or other publishing software.

## Syntax

Expand All @@ -28,13 +28,13 @@ new Indiekit.addPreset(options);
: The name of the publishing software the plug-in supports. **Required**.

`postTypes`
: An object providing default configuration values for publication [post types](../../configuration/post-types.md).
: An object providing default configuration values for publication [post types](../configuration/post-types.md).

## Methods

### `postTemplate()`

An (async) function providing a [post template](../../configuration/post-template.md).
An (async) function providing a [post template](../configuration/post-template.md).

### `init()`

Expand Down Expand Up @@ -101,7 +101,7 @@ get info() {

### Add post type defaults

A publication preset defines default store and URL path values for a publication’s [post types](../../concepts.md#post-type). Users can override these in their own [configuration](../../configuration/post-types.md).
A publication preset defines default store and URL path values for a publication’s [post types](../concepts.md#post-type). Users can override these in their own [configuration](../configuration/post-types.md).

For example, to add default values for `note` and `photo` post types:

Expand Down
2 changes: 1 addition & 1 deletion docs/api/add-store.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# `Indiekit.addStore`

A [content store](../../concepts.md#content-store) interfaces with CRUD (create, read, update, delete) methods provided by a file system, version control system, server, database or API.
A [content store](../concepts.md#content-store) interfaces with CRUD (create, read, update, delete) methods provided by a file system, version control system, server, database or API.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/api/add-syndicator.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ outline: deep

# `Indiekit.addSyndicator`

A [syndicator](../../concepts.md#syndicator) shares content to a third-party service such as a social network, typically via its API.
A [syndicator](../concepts.md#syndicator) shares content to a third-party service such as a social network, typically via its API.

## Syntax

Expand Down
2 changes: 1 addition & 1 deletion docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ A plug-in can provide any of the following features:

## Anatomy of a plug-in

A plug-in is a `Class` with an `init()` function that is used to register endpoints, presets, stores and syndicators. You can also use the `init()` function to modify Indiekit’s [configuration](../../configuration/index.md). For example:
A plug-in is a `Class` with an `init()` function that is used to register endpoints, presets, stores and syndicators. You can also use the `init()` function to modify Indiekit’s [configuration](../configuration/index.md). For example:

```js
export default class PluginName {
Expand Down
4 changes: 2 additions & 2 deletions docs/configuration/publication.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ Your website’s URL. **Required**.

## `mediaStore`

A string representing the package name of a [content store plugin](../plugins/stores.md) to use for storing media files. If no value is provided, the [default content store](#store) is used.
A string representing the package name of a [content store plugin](../plugins/stores/index.md) to use for storing media files. If no value is provided, the [default content store](#store) is used.

## `postTemplate`

Expand Down Expand Up @@ -284,7 +284,7 @@ Defaults to `"-"` (hyphen).

## `store`

A string representing the package name of a [content store plugin](../plugins/stores.md). If no value is provided, the first store plug-in listed under `plugins` is used.
A string representing the package name of a [content store plugin](../plugins/stores/index.md). If no value is provided, the first store plug-in listed under `plugins` is used.

## `storeMessageTemplate`

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/endpoints/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Endpoints

An [endpoint](../concepts#endpoint) is a path on your Indiekit server that applications can send requests to or users can access certain features at.
An [endpoint](../../concepts#endpoint) is a path on your Indiekit server that applications can send requests to or users can access certain features at.

## Pre-installed plug-ins

Expand Down
10 changes: 5 additions & 5 deletions docs/plugins/index.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
# Plug-ins

* [Content stores](stores.md)
* [Content stores](stores/index.md)
Save post and media files to third-party content stores.

* [Endpoints](endpoints.md)
* [Endpoints](endpoints/index.md)
Add extra features or support other IndieWeb protocols.

* [Post types](post-types.md)
* [Post types](post-types/index.md)
Add new post types.

* [Publication presets](presets.md)
* [Publication presets](presets/index.md)
Provide default values for post types and post templates.

* [Syndicators](syndicators.md)
* [Syndicators](syndicators/index.md)
Enable content to be posted to third-party websites.

> [!TIP]
Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/post-types/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Post types

A [post type](../concepts#post-type) provides an interface for creating and editing different content types.
A [post type](../../concepts#post-type) provides an interface for creating and editing different content types.

## Pre-installed plug-ins

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/presets/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Publication presets

A [publication preset](../concepts#publication-preset) provides default values for post types and post templates. Plug-ins are available for the following platforms:
A [publication preset](../../concepts#publication-preset) provides default values for post types and post templates. Plug-ins are available for the following platforms:

## Pre-installed plug-ins

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/stores/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Content stores

A [content store](../concepts#content-store) is a location where Indiekit can save post content and media files. Plug-ins are available for the following platforms:
A [content store](../../concepts#content-store) is a location where Indiekit can save post content and media files. Plug-ins are available for the following platforms:

## Official plug-ins

Expand Down
2 changes: 1 addition & 1 deletion docs/plugins/syndicators/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Syndicators

A [syndicator](../concepts#syndicator) enables content to be posted to third-party websites, in addition to your own. Plug-ins are available for the following platforms:
A [syndicator](../../concepts#syndicator) enables content to be posted to third-party websites, in addition to your own. Plug-ins are available for the following platforms:

## Official plug-ins

Expand Down

0 comments on commit 131ff2b

Please sign in to comment.