slweb

slweb is a static website generator which aims at being simplistic. It transforms custom Markdown-like syntax into HTML.

Manual

See https://strahinja.srht.site/man/slweb/slweb.1.html.

Q&A

Q: Is this suckless?: A: No. SGML, and by extension, HTML, isn't suckless.

Q: Why do you call it “simple” then?: A: Because one is not the synonym for the other.

Q: Why not make a website generator as a shell script?: A: slweb was a shell script in its conception (check its history of commits in git). However, I wanted to implement Markdown links with link ids [like][this]. This requires multiple passes by the parser and is better implemented as a full-blown program in C anyway. The other reason was that sed and awk have limits, which some of my pages hit.
[this]: https://some.site

Q: My static website generator is “truly simple”, this is not simple!: A: Good for you. By the way, that is a statement and not a question.

Prerequisites

C compiler - defaults in config.mk

Optional dependencies

KaTeX for math mode
git (for {git-log})
identify from ImageMagick (for <img width="" height="">)

Install

$ git clone https://git.sr.ht/~strahinja/slweb
$ cd slweb
$ su
# make install

With got:

$ got clone https://git.sr.ht/~strahinja/slweb
$ got checkout slweb.git
$ cd slweb
$ su
# make install

Persistent build configuration file

The file config.mk will be sourced when building targets which also accept configuration through environment variables. For example, CPPFLAGS and PREFIX are specified in config.mk.

OpenBSD

Before running make(1), comment the CPPFLAGS definition in config.mk above the line with the “OpenBSD” comment and uncomment the one below it:

#CPPFLAGS	= -D_DEFAULT_SOURCE -D_POSIX_C_SOURCE=200809L \
#		  -D_XOPEN_SOURCE=700
# OpenBSD
CPPFLAGS	= -D_DEFAULT_SOURCE -D_POSIX_C_SOURCE=200809L \
		  -D_XOPEN_SOURCE=700 -D_BSD_SOURCE

Also, do the same for MANPREFIX:

#MANPREFIX	= $(DESTDIR)$(PREFIX)/share/man
# OpenBSD
MANPREFIX	= $(DESTDIR)$(PREFIX)/man

Install (Arch)

$ git clone https://aur.archlinux.org/slweb.git
$ cd slweb
$ makepkg -si

Examples

See the examples/ directory in this repository.

Given the file index.slw in the current directory:

---
site-name: Test website
site-desc: My first website in slweb
---

{main}
# Hello world

This is an _example_ of a statically generated HTML.

{/main}

after using the command:

$ slweb index.slw > index.html

file index.html contains:

<!DOCTYPE html>
<html lang="en">
<head>
    <title>Test website</title>
    <meta charset="utf8">
    <meta name="description" content="My first website in slweb">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <meta name="generator" content="slweb">
</head>
<body>

<main>
<h1>Hello world</h1>

<p>This is an <em>example</em> of a statically generated HTML.</p>

</main>
</body>
</html>

TODO (checklist)

See the file TODO for more information.

Bugs and limitations

Bugs can be reported using the ticket tracker. See the manpage (man slweb) after installing slweb for more information.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.

Previous commit: index.slw 90d6fb1 2024-11-03 15:28:19 +0000 (Страхиња Радић) (HEAD -> master, origin/master, origin/HEAD)