updated docs

This commit is contained in:
Niko Abeler 2022-11-01 21:57:51 +01:00
parent 8c1d7fd8c7
commit 5f3978eaac
1 changed files with 56 additions and 19 deletions

View File

@ -23,8 +23,10 @@ Each directory in the `/users/` directory of a repository is considered a user.
-- This will be rendered as the blog post. -- This will be rendered as the blog post.
-- Must be present for the blog post to be valid. -- Must be present for the blog post to be valid.
-- All other folders will be ignored -- All other folders will be ignored
\- webmentions.yml \- incoming_webmentions.yml
-- Used to track incoming and outgoing webmentions -- Used to track incoming webmentions
\- outgoing_webmentions.yml
-- Used to track outgoing webmentions
\- media/ \- media/
-- Contains all media files used in the blog post. -- Contains all media files used in the blog post.
-- All files in this folder will be publicly available -- All files in this folder will be publicly available
@ -34,16 +36,33 @@ Each directory in the `/users/` directory of a repository is considered a user.
\- meta/ \- meta/
\- base.html \- base.html
-- The template used to render all sites -- The template used to render all sites
\- config.yml
-- Holds information about the user
\- VERSION \- VERSION
-- Contains the version string. -- Contains the version string.
-- Used to determine compatibility in the future -- Used to determine compatibility in the future
\- media/ \- media/
-- All this files will be publicly available. To be used for general files -- All this files will be publicly available. To be used for general files
\- avatar.{png, jpg, jpeg, gif} \- avatar.{png|jpg|jpeg|gif}
-- The avatar for the user -- Optional: Avatar to be used in various places
\- config.yml \- favicon.{png|jpg|jpeg|gif|ico}
-- Contains settings global to the user. -- Optional: Favicon for the site
-- For example: page title and style options ```
### User Config
Stored in `meta/config.yml`
```
title: "Title of the Blog"
subtitle: "Subtitle of the Blog"
header_color: "#ff0000"
author_name: "Your Name"
me:
- name: "Connect on Mastodon"
url: "https://chaos.social/@h4kor"
- name: "I'm on Twitter"
url: "https://twitter.com/h4kor"
``` ```
### Post ### Post
@ -51,33 +70,51 @@ Each directory in the `/users/` directory of a repository is considered a user.
Posts are Markdown files with a mandatory metadata head. Posts are Markdown files with a mandatory metadata head.
- The `title` will be added to the web page and does not have to be reapeated in the body. It will be used in any lists of posts. - The `title` will be added to the web page and does not have to be reapeated in the body. It will be used in any lists of posts.
- `description` is optional. At the moment this is only used for the HTML head meta data.
- `aliases` are optional. They are used as permanent redirects to the actual blog page. - `aliases` are optional. They are used as permanent redirects to the actual blog page.
- `draft` is false by default. If set to `true` the post will not be accessible.
- `reply` optional. Will add the link to the top of the post with `rel="in-reply-to"`. For more infos see: [https://indieweb.org/reply](https://indieweb.org/reply)
``` ```
--- ---
title: My new Post title: My new Post
Description: Short text used in meta data (and lists in the future)
date: 13 Aug 2022 17:07 UTC date: 13 Aug 2022 17:07 UTC
aliases: aliases:
- /my/new/post - /my/new/post
- /old_blog_path/ - /old_blog_path/
draft: false
reply:
url: https://link.to/referred_post
text: Text used for link
--- ---
Actual post Actual post
``` ```
### Webmentions
#### webmentions.yml This feature is not yet full supported and needs a lot of manual work. Expect this to change quiet frequently and breaking existing usages.
To send webmentions use the command `owl webmention`
Retrieved webmentions have to be approved manually by changing the `approval_status` in the `incoming_webmentions.yml` file.
#### incoming_webmentions.yml
``` ```
incoming: - source: https://example.com/post
- source: https://example.com/post title: Example Post
title: Example Post approval_status: ["", "approved", "rejected"]
ApprovalStatus: ["", "approved", "rejected"] retrieved_at: 2021-08-13T17:07:00Z
retrieved_at: 2021-08-13T17:07:00Z ```
outgoing:
- target: https://example.com/post #### outgoing_webmentions.yml
supported: true
scanned_at: 2021-08-13T17:07:00Z ```
last_sent_at: 2021-08-13T17:07:00Z - target: https://example.com/post
``` supported: true
scanned_at: 2021-08-13T17:07:00Z
last_sent_at: 2021-08-13T17:07:00Z
```