tangled
alpha
login
or
join now
apoena.dev
/
remanso-cli
0
fork
atom
this repo has no description
0
fork
atom
overview
issues
pulls
pipelines
chore: udpate docs
stevedylan.dev
1 month ago
b06b094d
bde611d3
+26
-15
2 changed files
expand all
collapse all
unified
split
docs
docs
pages
config.mdx
supported-frameworks.mdx
+25
-4
docs/docs/pages/config.mdx
···
14
14
| `pdsUrl` | `string` | No | `"https://bsky.social"` | PDS server URL, generated automatically |
15
15
| `identity` | `string` | No | - | Which stored identity to use |
16
16
| `frontmatter` | `object` | No | - | Custom frontmatter field mappings |
17
17
+
| `ignore` | `string[]` | No | - | Glob patterns for files to ignore |
17
18
18
19
### Example
19
20
20
21
```json
21
22
{
22
22
-
"siteUrl": "https://myblog.com",
23
23
-
"contentDir": "./content/posts",
24
24
-
"publicationUri": "at://did:plc:abc123/site.standard.publication/self",
25
25
-
"pathPrefix": "/blog"
23
23
+
"siteUrl": "https://example.com",
24
24
+
"contentDir": "content/posts",
25
25
+
"imagesDir": "src/assets",
26
26
+
"publicDir": "public",
27
27
+
"outputDir": "dist",
28
28
+
"pathPrefix": "/posts",
29
29
+
"publicationUri": "at://did:plc:kq6bvkw4sxof3vdinuitehn5/site.standard.publication/3mdlavhxjhm2v",
30
30
+
"pdsUrl": "https://andromeda.social",
31
31
+
"frontmatter": {
32
32
+
"publishDate": "date"
33
33
+
},
34
34
+
"ignore": ["_index.md"]
26
35
}
27
36
```
28
37
···
60
69
}
61
70
}
62
71
```
72
72
+
73
73
+
### Ignoring Files
74
74
+
75
75
+
Some frameworks use special files like `_index.md` (Zola) for section pages that aren't actual blog posts. Use the `ignore` field to skip these files during publishing:
76
76
+
77
77
+
```json
78
78
+
{
79
79
+
"ignore": ["_index.md", "**/drafts/**"]
80
80
+
}
81
81
+
```
82
82
+
83
83
+
Patterns use glob syntax and are matched against relative paths from `contentDir`.
+1
-11
docs/docs/pages/supported-frameworks.mdx
···
11
11
| 11ty | ✅ |
12
12
| Next.js | ✅ |
13
13
| Gatsby | ✅ |
14
14
-
| Nuxt | ? |
15
14
| SvelteKit | ✅ |
16
16
-
| Remix | ? |
17
15
| Jekyll | ? |
18
18
-
| Docusaurus | ? |
19
19
-
| VuePress | ? |
20
20
-
| Gridsome | ? |
21
21
-
| Scully | ? |
22
22
-
| Elder.js | ? |
23
23
-
| Bridgetown | ? |
24
24
-
| Zola | ? |
25
25
-
| Pelican | ? |
26
26
-
| Hexo | ? |
16
16
+
| Zola | ✅ |