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-16 16:21:21 +0800
committerPeter Cai <[email protected]>2020-04-16 16:21:21 +0800
commit81fda6e1c853a95be4c1a89c3464054bd4be3f0b (patch)
tree49cb4461cc642f5d3cf833d2f276d3a28ec7608a /README.md
parenta9e3490478b2a0bec4efa91a33b272efd48b0387 (diff)
downloadpaprika-81fda6e1c853a95be4c1a89c3464054bd4be3f0b.tar.gz
add a preferred_url option
Diffstat (limited to 'README.md')
-rw-r--r--README.md3
1 files changed, 3 insertions, 0 deletions
diff --git a/README.md b/README.md
index 172b9a0..d2baa82 100644
--- a/README.md
+++ b/README.md
@@ -67,6 +67,7 @@ This is the main configuration file. The file will be compiled statically into t
"plugin_identifier": "com.example.change.this.to.whatever.you.like",
"posts_per_page": 5,
"cache_maxage": 86400,
+ "preferred_url": "<your_url>",
"redirects": {
"/foo": "/bar",
...
@@ -90,6 +91,8 @@ This is the main configuration file. The file will be compiled statically into t
`plugin_identifier`: Used in Standard Notes to distinguish plugins.
+`preferred_url`: OPTIONAL. The preferred URL to use for the options "Open Post" and "Open Blog" (and for these options ONLY) in the Standard Notes Actions menu. Must NOT include a trailing `/`. This is useful if you publish your blog at `https://your_domain.com` but use a `workers.dev` domain for your Standard Notes plugin address.
+
`redirects`: OPTIONAL. A map of URLs where the key will be mapped to the value by Paprika using 301 redirects. This is mainly useful for migration from another blogging platform.
`cache_maxage`: OPTIONAL. A value in seconds determining how long the browser should cache static resources from the blog. If omitted, the default value is a week.