~kris/hacks

spod

ref: 7f1fef5e238859d2cb29e2213d2fa8c934a0e64e spod/spod.1 -rw-r--r-- 1.1 KiB
7f1fef5e — Kris Yotam convert README.md to README.txt 4 months ago
                                                                                
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
.Dd 2026-04-29
.Dt SPOD 1
.Os
.Sh NAME
.Nm spod
.Nd static podcast page generator
.Sh SYNOPSIS
.Nm
.Ar podcastdir
.Op Ar outputdir
.Sh DESCRIPTION
.Nm
generates static HTML pages for podcasts, similar to
.Xr stagit 1
for git repositories.
.Pp
.Ar podcastdir
is a parent directory containing one subdirectory per podcast.
Each podcast directory should contain:
.Bl -bullet
.It
Audio files (.mp3, .ogg, .opus, .m4a, .flac, .wav)
.It
A README, README.md, or README.txt file (optional)
.It
A cover image named COVER.* or cover.* (optional)
.El
.Pp
If
.Ar outputdir
is not specified, output is written to
.Pa out/
in the current directory.
.Sh EXAMPLE LAYOUT
.Bd -literal
podcasts/
  my-show/
    COVER.jpg
    README.md
    001-first-episode.mp3
    002-second-episode.mp3
  another-show/
    cover.png
    README
    intro.ogg
.Ed
.Pp
Running
.Nm
.Pa podcasts/
generates a static site with an index page listing all shows
and per-show pages with episode tables, cover art, and descriptions.
.Pp
Audio files are symlinked into the output directory, not copied.
.Sh SEE ALSO
.Xr stagit 1
.Sh AUTHORS
Kris Yotam