aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 33c388773fed52c449e42a09fc2912af2d3e882c (plain) (blame)
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
# seen

*A simple blog generator*

### Facts

- Doesn't depend on GNU extensions

- POSIX compliant

- Works on non-GNU distros (such as Alpine)

- Works on BSD systems (such as MacOS and OpenBSD)

- Depends on `markdown`/`hoedown`

- Less than 100 SLOC

### How to use

First, install `markdown`/`hoedown` because this script uses it heavily.

Put your markdown files on `articles/<name of file>.md` (create the directory if it doesn't exist).

You also need to create a config file. Put it in `articles/<name of file>.cfg`. It should use the same name your markdown file uses:

	name="Hello World"
	desc="Welcome to my blog!"
	date="9th December 2021"

You can create RSS feeds too, just modify the `rss.cfg` file to your liking:

	rssEnabled="y" # Enable RSS
	rssBlogTitle="foobar's blog"
	rssBlogDescription="foobar loves cooking!!!!!!!"

And run the following:

	$ chmod +x seen.sh
	$ ./seen.sh

Your blog is in the `www/` directory. You can make your webserver use it.
You can also use CSS files, just put them into the `templates/` directory.

Feel free to customize other html files present in that directory.

Seen supports other options too, for more info, run the following:

	$ ./seen.sh --help