27 lines
1.5 KiB
Markdown
27 lines
1.5 KiB
Markdown
|
# Counterweight Posts
|
||
|
|
|
||
|
|
This is where I keep my blog posts. The structure does not follow any blog
|
||
|
|
convention: I keep my stuff here the way I like to prevent lock-in into any
|
||
|
|
specific blog service or technology. Once I want to render all of this into a
|
||
|
|
real blog, I just develop and run some small code to adapt the contents to the
|
||
|
|
concrete solution I will be using.
|
||
|
|
|
||
|
|
## Structure
|
||
|
|
|
||
|
|
Posts should be stored in the `posts` folder. Each post:
|
||
|
|
- Should have its own folder. The folder name must be a unique slug.
|
||
|
|
- Must contain two files inside:
|
||
|
|
- `content.md`: the actual post, as markdown.
|
||
|
|
- `meta.yaml`: metadata on the post. This is a flexible file and generally,
|
||
|
|
there are no limits to what to store here. Below is a table of fields
|
||
|
|
that are expected.
|
||
|
|
|
||
|
|
| Field | Description |
|
||
|
|
|------------|---------------------------------------------------------------------------------------------|
|
||
|
|
| `title` | The human readable title for the post. |
|
||
|
|
| `date` | The posting date of the post, with format `YYYY-MM-DD HH:MM:SS`, as in 2021-05-30 11:59:59. |
|
||
|
|
| `category` | A category for the post. |
|
||
|
|
| `tags` | A list of tags, represented as comma separated strings. |
|
||
|
|
| `slug` | Unique, machine readable slug. |
|
||
|
|
| `authors` | List of authors, represented as comma separated strings. |
|
||
|
|
| `summary` | A brief, human readable summary for the post. |
|