index : paprika

A blogging platform written in Rust for Cloudflare Workers, integrated with Standard Notes

path: root/README.md
diff options
context:
space:
mode:
authorPeter Cai <[email protected]>2020-04-14 21:28:05 +0800
committerPeter Cai <[email protected]>2020-04-14 21:28:05 +0800
commitc1304581e6392d3430983c5b68ccc2d23a8d6719 (patch)
tree0eb10e9ca32ab1c7e033c6ea7e3f605af88a34bd /README.md
parentae525c3a0742ae81586a88f0c3bde9f41a3b96d0 (diff)
downloadpaprika-c1304581e6392d3430983c5b68ccc2d23a8d6719.tar.gz
README: document per-post theme_config
Diffstat (limited to 'README.md')
-rw-r--r--README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/README.md b/README.md
index 7e30de4..172b9a0 100644
--- a/README.md
+++ b/README.md
@@ -149,7 +149,12 @@ By default, the timestamp and the URL of any new post will be generated automati
{
"url": "some-awesome-url",
"timestamp": "YYYY-mm-dd",
- "unlist": true
+ "unlist": true,
+ "theme_config": {
+ "no_itte": false,
+ "itte_page_path": "...",
+ ...
+ }
}
```
~~~
@@ -160,6 +165,12 @@ By default, the timestamp and the URL of any new post will be generated automati
`unlist` / `unlisted`: when set to `true`, the post won't appear in home page, while still being accessible via its URL.
+`theme_config`: OPTIONAL. You can pass parameters to the theme via this option. This will be available in `post.hbs` as the `theme_config` variable in execution context. Consult the theme for detailed information on what's available. For the default theme:
+
+`theme_config.no_itte`: OPTIONAL. When set to true, there will be no Itte comment box on this post.
+
+`theme_config.itte_page_path`: OPTIONAL. Override the path that identifies the page in Itte database. This is useful for migration from another blog software also using Itte. You can use this to instruct Itte to behave as if the page URL hasn't changed.
+
Normally, if such a customization header is not present, a post's metadata (URL and timestamp) will not be updated when you update a post. However, when this header is present, then the metadata will __always__ be updated.
When a post's `url` is changed, the old one will become an alias, 302-redirected to the new one.