apoena.dev
this repo has no description
docs: lint documentation
+42
-42
docs/docs/pages/config.mdx
+42
-42
docs/docs/pages/config.mdx
···
1
1
# Configuration Reference
2
2
3
-
## `sequoia.json`
3
+
## `remanson.json`
4
4
5
-
| Field | Type | Required | Default | Description |
6
-
|-------|------|----------|---------|-------------|
7
-
| `siteUrl` | `string` | Yes | - | Base URL of your website |
8
-
| `contentDir` | `string` | Yes | - | Directory containing blog post files |
9
-
| `publicationUri` | `string` | Yes | - | AT-URI of your publication record |
10
-
| `imagesDir` | `string` | No | - | Directory containing cover images |
11
-
| `publicDir` | `string` | No | `"./public"` | Static folder for `.well-known` files |
12
-
| `outputDir` | `string` | No | - | Built output directory for inject command |
13
-
| `pathPrefix` | `string` | No | `"/posts"` | URL path prefix for posts |
14
-
| `pdsUrl` | `string` | No | `"https://bsky.social"` | PDS server URL, generated automatically |
15
-
| `identity` | `string` | No | - | Which stored identity to use |
16
-
| `frontmatter` | `object` | No | - | Custom frontmatter field mappings |
17
-
| `frontmatter.slugField` | `string` | No | - | Frontmatter field to use for slug (defaults to filepath) |
18
-
| `ignore` | `string[]` | No | - | Glob patterns for files to ignore |
19
-
| `removeIndexFromSlug` | `boolean` | No | `false` | Remove `/index` or `/_index` suffix from slugs |
20
-
| `stripDatePrefix` | `boolean` | No | `false` | Remove `YYYY-MM-DD-` date prefixes from slugs (Jekyll-style) |
21
-
| `pathTemplate` | `string` | No | - | URL path template with tokens (overrides `pathPrefix` + slug) |
22
-
| `bluesky` | `object` | No | - | Bluesky posting configuration |
23
-
| `bluesky.enabled` | `boolean` | No | `false` | Post to Bluesky when publishing documents (also enables [comments](/comments)) |
24
-
| `bluesky.maxAgeDays` | `number` | No | `30` | Only post documents published within this many days |
25
-
| `ui` | `object` | No | - | UI components configuration |
26
-
| `ui.components` | `string` | No | `"src/components"` | Directory where UI components are installed |
5
+
| Field | Type | Required | Default | Description |
6
+
| ----------------------- | ---------- | -------- | ----------------------- | ------------------------------------------------------------------------------ |
7
+
| `siteUrl` | `string` | Yes | - | Base URL of your website |
8
+
| `contentDir` | `string` | Yes | - | Directory containing blog post files |
9
+
| `publicationUri` | `string` | Yes | - | AT-URI of your publication record |
10
+
| `imagesDir` | `string` | No | - | Directory containing cover images |
11
+
| `publicDir` | `string` | No | `"./public"` | Static folder for `.well-known` files |
12
+
| `outputDir` | `string` | No | - | Built output directory for inject command |
13
+
| `pathPrefix` | `string` | No | `"/posts"` | URL path prefix for posts |
14
+
| `pdsUrl` | `string` | No | `"https://bsky.social"` | PDS server URL, generated automatically |
15
+
| `identity` | `string` | No | - | Which stored identity to use |
16
+
| `frontmatter` | `object` | No | - | Custom frontmatter field mappings |
17
+
| `frontmatter.slugField` | `string` | No | - | Frontmatter field to use for slug (defaults to filepath) |
18
+
| `ignore` | `string[]` | No | - | Glob patterns for files to ignore |
19
+
| `removeIndexFromSlug` | `boolean` | No | `false` | Remove `/index` or `/_index` suffix from slugs |
20
+
| `stripDatePrefix` | `boolean` | No | `false` | Remove `YYYY-MM-DD-` date prefixes from slugs (Jekyll-style) |
21
+
| `pathTemplate` | `string` | No | - | URL path template with tokens (overrides `pathPrefix` + slug) |
22
+
| `bluesky` | `object` | No | - | Bluesky posting configuration |
23
+
| `bluesky.enabled` | `boolean` | No | `false` | Post to Bluesky when publishing documents (also enables [comments](/comments)) |
24
+
| `bluesky.maxAgeDays` | `number` | No | `30` | Only post documents published within this many days |
25
+
| `ui` | `object` | No | - | UI components configuration |
26
+
| `ui.components` | `string` | No | `"src/components"` | Directory where UI components are installed |
27
27
28
28
### Example
29
29
···
54
54
55
55
## Post Frontmatter
56
56
57
-
| Field | Type | Required | Default Mapping | Description |
58
-
|-------|------|----------|-----------------|-------------|
59
-
| `title` | `string` | Yes | `"title"` | Post title |
60
-
| `description` | `string` | No | `"description"` | Post description/summary |
61
-
| `publishDate` | `string` | Yes | `"publishDate"`, `"pubDate"`, `"date"`, `"createdAt"`, `"created_at"` | Publication date |
62
-
| `coverImage` | `string` | No | `"ogImage"` | Cover image filename |
63
-
| `tags` | `string[]` | No | `"tags"` | Post tags/categories |
64
-
| `draft` | `boolean` | No | `"draft"` | If `true`, post is skipped during publish |
57
+
| Field | Type | Required | Default Mapping | Description |
58
+
| ------------- | ---------- | -------- | --------------------------------------------------------------------- | ----------------------------------------- |
59
+
| `title` | `string` | Yes | `"title"` | Post title |
60
+
| `description` | `string` | No | `"description"` | Post description/summary |
61
+
| `publishDate` | `string` | Yes | `"publishDate"`, `"pubDate"`, `"date"`, `"createdAt"`, `"created_at"` | Publication date |
62
+
| `coverImage` | `string` | No | `"ogImage"` | Cover image filename |
63
+
| `tags` | `string[]` | No | `"tags"` | Post tags/categories |
64
+
| `draft` | `boolean` | No | `"draft"` | If `true`, post is skipped during publish |
65
65
66
66
### Example
67
67
···
130
130
131
131
**Available tokens:**
132
132
133
-
| Token | Description | Example |
134
-
|-------|-------------|---------|
135
-
| `{slug}` | The generated slug (from filepath or `slugField`) | `my-post` |
136
-
| `{year}` | Four-digit publish year (local time) | `2024` |
137
-
| `{yearUTC}` | Four-digit publish year (UTC) | `2024` |
138
-
| `{month}` | Zero-padded publish month (local time) | `01` |
139
-
| `{monthUTC}` | Zero-padded publish month (UTC) | `01` |
140
-
| `{day}` | Zero-padded publish day (local time) | `15` |
141
-
| `{dayUTC}` | Zero-padded publish day (UTC) | `15` |
142
-
| `{title}` | Slugified post title | `my-first-post` |
143
-
| `{field}` | Any frontmatter field value (string fields only) | - |
133
+
| Token | Description | Example |
134
+
| ------------ | ------------------------------------------------- | --------------- |
135
+
| `{slug}` | The generated slug (from filepath or `slugField`) | `my-post` |
136
+
| `{year}` | Four-digit publish year (local time) | `2024` |
137
+
| `{yearUTC}` | Four-digit publish year (UTC) | `2024` |
138
+
| `{month}` | Zero-padded publish month (local time) | `01` |
139
+
| `{monthUTC}` | Zero-padded publish month (UTC) | `01` |
140
+
| `{day}` | Zero-padded publish day (local time) | `15` |
141
+
| `{dayUTC}` | Zero-padded publish day (UTC) | `15` |
142
+
| `{title}` | Slugified post title | `my-first-post` |
143
+
| `{field}` | Any frontmatter field value (string fields only) | - |
144
144
145
145
When `pathTemplate` is set, it overrides `pathPrefix`. If `pathTemplate` is not set, the default `pathPrefix`/slug behavior is used.
146
146