Skip to content

Commit

Permalink
docs: add store and mediaStore publication options
Browse files Browse the repository at this point in the history
  • Loading branch information
paulrobertlloyd committed Apr 6, 2024
1 parent d35a361 commit 04965a9
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 17 deletions.
48 changes: 32 additions & 16 deletions docs/configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,49 +36,65 @@ Indiekit’s configuration file uses the following top-level properties:
{
"application": {
"locale": "de",
"name": "Unabhängigkeit"
"name": "Indiekit-Server"
},
"publication": {
"locale": "de",
"me": "https://website.example",
"postTypes": {
"event": {
"name": "Veranstaltungen"
}
}
"mediaStore": "@indiekit/store-s3",
"store": "@indiekit/store-github"
},
"plugins": [
"@indiekit/post-type-event",
"@indiekit/preset-hugo"
"@indiekit/preset-hugo",
"@indiekit/store-github",
"@indiekit/store-s3"
],
"@indiekit/preset-hugo": {
"frontMatterFormat": "yaml"
}
},
"@indiekit/store-github": {
"user": "example",
"repo": "website"
},
"@indiekit/store-s3": {
"region": "eu-central-1",
"endpoint": "https://s3-example-eu-central-1.amazonaws.com",
"bucket": "website"
},
}
```

```js [JavaScript]
export default {
application: {
locale: "de",
name: "Unabhängigkeit"
name: "Indiekit-Server"
},
publication: {
locale: "de",
me: "https://website.example",
postTypes: {
event: {
name: "Veranstaltungen"
}
}
mediaStore: "@indiekit/store-s3",
store: "@indiekit/store-github"
},
plugins: [
"@indiekit/post-type-event",
"@indiekit/preset-hugo"
"@indiekit/preset-hugo",
"@indiekit/store-github",
"@indiekit/store-s3"
],
"@indiekit/preset-hugo": {
frontMatterFormat: "yaml"
}
},
"@indiekit/store-github": {
user: "example",
repo: "website"
},
"@indiekit/store-s3": {
region: "eu-central-1",
endpoint: "https://s3-example-eu-central-1.amazonaws.com",
bucket: "website"
},
}
```

Expand Down
10 changes: 9 additions & 1 deletion docs/configuration/publication.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ Defaults to `false`.

When enabled, Indiekit will try to fetch Microformats data for any URL in a new post (for example URLs for `bookmark-of`, `like-of`, `repost-of`, `in-reply-to`).

If any data is found, a `references` property will be included in the resulting post data. For example, given the following Micropub request:
If any data is found, a `references` property is included in the resulting post data. For example, given the following Micropub request:

```sh
POST /micropub HTTP/1.1
Expand Down Expand Up @@ -104,6 +104,10 @@ Defaults to `"en"` (English).

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.

## `postTemplate`

A post template is a function that takes post properties received and parsed by the Micropub endpoint and renders them in a given file format, for example, a Markdown file with YAML front matter.
Expand Down Expand Up @@ -240,6 +244,10 @@ A string representing the character used to replace spaces when creating a slug.

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.

## `storeMessageTemplate`

A function that can be used to customise messages used when saving files to content stores that save messages with each change, for example git repositories.
Expand Down

0 comments on commit 04965a9

Please sign in to comment.