Fix minor grammatical issues, mostly in docs
parent
a6321f52d8
commit
c30033c19e
|
@ -27,7 +27,7 @@
|
||||||
{{ utils.actor_action(inbox_object, "followed you") }}
|
{{ utils.actor_action(inbox_object, "followed you") }}
|
||||||
{{ utils.display_actor(inbox_object.actor, actors_metadata) }}
|
{{ utils.display_actor(inbox_object.actor, actors_metadata) }}
|
||||||
{% elif inbox_object.ap_type == "Like" %}
|
{% elif inbox_object.ap_type == "Like" %}
|
||||||
{{ utils.actor_action(inbox_object, "liked one of your post", with_icon=True) }}
|
{{ utils.actor_action(inbox_object, "liked one of your posts", with_icon=True) }}
|
||||||
{{ utils.display_object(inbox_object.relates_to_anybox_object) }}
|
{{ utils.display_object(inbox_object.relates_to_anybox_object) }}
|
||||||
{% else %}
|
{% else %}
|
||||||
<p>
|
<p>
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# Developer's guide
|
# Developer's guide
|
||||||
|
|
||||||
This guide assume you have some knoweldge of [ActivityPub](https://activitypub.rocks/).
|
This guide assumes you have some knoweldge of [ActivityPub](https://activitypub.rocks/).
|
||||||
|
|
||||||
[TOC]
|
[TOC]
|
||||||
|
|
||||||
|
|
|
@ -11,7 +11,7 @@ For now, there's no image published on Docker Hub, this means you will have to b
|
||||||
Clone the repository, replace `you-domain.tld` by your own domain.
|
Clone the repository, replace `you-domain.tld` by your own domain.
|
||||||
|
|
||||||
Note that if you want to serve static assets via your reverse proxy (like nginx), clone it in a place
|
Note that if you want to serve static assets via your reverse proxy (like nginx), clone it in a place
|
||||||
where accessible by your reverse proxy user.
|
where it is accessible by your reverse proxy user.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://git.sr.ht/~tsileo/microblog.pub your-domain.tld
|
git clone https://git.sr.ht/~tsileo/microblog.pub your-domain.tld
|
||||||
|
|
|
@ -29,7 +29,7 @@ You can tweak your profile by tweaking these items:
|
||||||
- `summary` (using Markdown)
|
- `summary` (using Markdown)
|
||||||
- `icon_url`
|
- `icon_url`
|
||||||
|
|
||||||
Whenever one of these config items is updated, an `Update` activity will be sent to all know server to update your remote profile.
|
Whenever one of these config items is updated, an `Update` activity will be sent to all known servers to update your remote profile.
|
||||||
|
|
||||||
The server will need to be restarted for taking changes into account.
|
The server will need to be restarted for taking changes into account.
|
||||||
|
|
||||||
|
@ -39,7 +39,7 @@ You can add metadata to your profile with the `metadata` config item.
|
||||||
|
|
||||||
Markdown is supported in the `value` field.
|
Markdown is supported in the `value` field.
|
||||||
|
|
||||||
Be aware that most other softwares like Mastodon will limit the number of key/value to 4.
|
Be aware that most other software like Mastodon will limit the number of key/value to 4.
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
metadata = [
|
metadata = [
|
||||||
|
@ -68,9 +68,9 @@ hides_followers = true
|
||||||
|
|
||||||
The default value is `false`.
|
The default value is `false`.
|
||||||
|
|
||||||
### Hiding following
|
### Hiding who you are following
|
||||||
|
|
||||||
If you wish to hide your following, add this config item to `profile.toml`:
|
If you wish to hide who you are following, add this config item to `profile.toml`:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
hides_following = true
|
hides_following = true
|
||||||
|
@ -80,10 +80,10 @@ The default value is `false`.
|
||||||
|
|
||||||
### Privacy replace
|
### Privacy replace
|
||||||
|
|
||||||
You can define domain to be rewrited to more "privacy friendly" alternatives, like [Invidious](https://invidious.io/)
|
You can define domains to be rewritten to more "privacy friendly" alternatives, like [Invidious](https://invidious.io/)
|
||||||
or [Nitter](https://nitter.net/about).
|
or [Nitter](https://nitter.net/about).
|
||||||
|
|
||||||
To do so, just add as these extra config items, this is a sample config that rewrite URLs for Twitter, Youtube, Reddit and Medium:
|
To do so, add these extra config items. This is a sample config that rewrite URLs for Twitter, Youtube, Reddit and Medium:
|
||||||
|
|
||||||
```toml
|
```toml
|
||||||
privacy_replace = [
|
privacy_replace = [
|
||||||
|
@ -122,7 +122,7 @@ $primary-color: #e14eea;
|
||||||
$secondary-color: #32cd32;
|
$secondary-color: #32cd32;
|
||||||
```
|
```
|
||||||
|
|
||||||
See `app/scss/main.scss` to see what variables can be overidden.
|
See `app/scss/main.scss` to see what variables can be overridden.
|
||||||
|
|
||||||
#### Code highlighting theme
|
#### Code highlighting theme
|
||||||
|
|
||||||
|
@ -134,7 +134,7 @@ code_highlighting_theme = "solarized-dark"
|
||||||
|
|
||||||
### Blocking servers
|
### Blocking servers
|
||||||
|
|
||||||
In addition to blocking "single actors" via the admin interface, you can also prevent any communications with whole servers.
|
In addition to blocking "single actors" via the admin interface, you can also prevent any communication with entire servers.
|
||||||
|
|
||||||
Add a `blocked_servers` config item into `profile.toml`.
|
Add a `blocked_servers` config item into `profile.toml`.
|
||||||
|
|
||||||
|
@ -152,7 +152,7 @@ blocked_servers = [
|
||||||
|
|
||||||
Public notes will be visible on the homepage.
|
Public notes will be visible on the homepage.
|
||||||
|
|
||||||
Only the last 20 followers/follows you be showing on the public website.
|
Only the last 20 followers/follows you have will be shown on the public website.
|
||||||
|
|
||||||
And only the last 20 interactions (likes/shares/webmentions) will be displayed, to keep things simple/clean.
|
And only the last 20 interactions (likes/shares/webmentions) will be displayed, to keep things simple/clean.
|
||||||
|
|
||||||
|
@ -222,7 +222,7 @@ Receiving a share will trigger a notification, increment the shares counter on t
|
||||||
|
|
||||||
Liking an object will notify the author.
|
Liking an object will notify the author.
|
||||||
|
|
||||||
Unlike sharing, liked object are not displayed on the homepage.
|
Unlike sharing, liked objects are not displayed on the homepage.
|
||||||
|
|
||||||
Most receiving servers will increment the number of likes.
|
Most receiving servers will increment the number of likes.
|
||||||
|
|
||||||
|
@ -232,13 +232,13 @@ Receiving a like will trigger a notification, increment the likes counter on the
|
||||||
|
|
||||||
Bookmarks allow you to like objects without notifying the author.
|
Bookmarks allow you to like objects without notifying the author.
|
||||||
|
|
||||||
It is basically a "private like", and allow you to easily access them later.
|
It is basically a "private like", and allows you to easily access them later.
|
||||||
|
|
||||||
It will also prevent objects to be pruned.
|
It will also prevent objects to be pruned.
|
||||||
|
|
||||||
### Webmentions
|
### Webmentions
|
||||||
|
|
||||||
Sending webmention to ping mentioned websites is done automatically once a public note is authored.
|
Sending webmentions to ping mentioned websites is done automatically once a public note is authored.
|
||||||
|
|
||||||
Receiving a webmention will trigger a notification, increment the webmentions counter on the object and the source page will be displayed on the object permalink.
|
Receiving a webmention will trigger a notification, increment the webmentions counter on the object and the source page will be displayed on the object permalink.
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue