docs: channels

getindiekit · Nov 16, 2024 · decfe36 · decfe36
1 parent decc3dc
commit decfe36
Show file tree

Hide file tree

Showing 3 changed files with 41 additions and 0 deletions.
diff --git a/docs/configuration/publication.md b/docs/configuration/publication.md
@@ -53,6 +53,44 @@ export default {
 
 :::
 
+## `channels`
+
+A keyed collection of configuration properties for different channels, which can be used to organise posts within your publication. For example:
+
+::: code-group
+
+```json [JSON]
+{
+  "publication": {
+    "channels": {
+      "posts": {
+        "name": "Posts"
+      },
+      "pages": {
+        "name": "Pages"
+      }
+    }
+  }
+}
+```
+
+```js [JavaScript]
+export default {
+  publication: {
+    channels: {
+      posts: {
+        name: "Posts"
+      },
+      pages: {
+        name: "Pages"
+      }
+    }
+  }
+}
+```
+
+:::
+
 ## `enrichPostData`
 
 A boolean to determine if data about URLs referenced in new posts is fetched and appended to a post’s properties.

diff --git a/docs/configuration/tokens.md b/docs/configuration/tokens.md
@@ -59,6 +59,7 @@ The following tokens are only available for post files:
 
 | Token | Description |
 | :---- | :---------- |
+| `channel` | Channel provided in `mp-channel` property, else default channel UID. Token only available if `publication.channels` is configured. |
 | `slug` | Slug provided in `mp-slug` property, else slugified `name` property, else a 5 character string, for example `ycf9o` |
 
 ### Media file tokens

diff --git a/docs/specifications.md b/docs/specifications.md
@@ -56,6 +56,7 @@ The following [scopes](https://indieweb.org/scope) are supported:
 ### Extensions
 
 * [x] [Category](https://github.com/indieweb/micropub-extensions/issues/5) query
+* [x] [Channel](https://github.com/indieweb/micropub-extensions/issues/40) query
 * [x] [Post list](https://github.com/indieweb/micropub-extensions/issues/4) query
 * [x] [Supported properties](https://github.com/indieweb/micropub-extensions/issues/33) query
 * [x] [Supported queries](https://github.com/indieweb/micropub-extensions/issues/7) query
@@ -71,6 +72,7 @@ The following [scopes](https://indieweb.org/scope) are supported:
 
 ### Server commands
 
+* [x] `mp-channel`: Channel(s) to use for a published post
 * [x] `mp-photo-alt`: Alternative text to use for a published photo
 * [x] `mp-slug`: URL slug to use in published post
 * [x] `mp-syndicate-to`: Which syndication targets to syndicate post to