wb5/README.md
2023-05-14 13:20:25 -04:00

41 lines
970 B
Markdown

# wb5
5th iteration of the dogeystamp personal website, based on [barf](https://barf.bt.ht).
The following is an abridged version of the original README.
## Requirements
- rsync
- lowdown (other markdown parsers are good too)
- entr (optonal, for `make watch`)
- standard UNIX tools
---
## Basic Setup
```sh
make build
```
Blog content will be in the `build` directory.
Media (such as images, videos) are placed in the "public" folder and carried over to the "build" folder via rsync. You can easily remove this altogether inside the main `barf` script if you plan to store media elsewhere (or not use any at all).
---
## Post Structure
The first line of any markdown file inside your `posts` directory should start
with a h1 heading, then a line break, then the date in `YYYY-MM-DD` format.
Like so:
```
# This is the Post Title
2023-01-05
```
Changing this structure or date format will break things or require you to edit
the `barf` script accordingly.