brennen
/
wrt
1
0
Fork 0
Code Issues 0 Pull Requests 0 Releases 27 Wiki Activity
Almost-minimal filesystem based blog.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
450 Commits
1 Branch
2.2 MiB
 
 
 
Branch: main
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'main'
${ noResults }
wrt/README.md

2.9 KiB
Raw Permalink Blame History

wrt

wrt (WRiting Tool) is a static site / blog generator and some related utilities.

This project can be thought of as both a format for storing blog entries and other writing in folders and files, as well as the utilities for rendering them to a full-fledged web site. It's particularly well-suited to collections of blog entries organized by date.

wrt can be found at:

I have been using some version of this code to publish p1k3 since 2001, and have written various posts about it over the years.

installation and use

You'll need a Unix / Linux, and a relatively recent Perl installation. In practice I know that Debian Jessie or later (or Ubuntu 16.04 or later) and Perl 5.26.1 work.

The short version, CPAN edition:

cpan -i App::WRT

The short version, git edition:

git clone https://code.p1k3.com/gitea/brennen/wrt.git
cd wrt
perl Build.PL
./Build installdeps
./Build test
./Build install

Starting a new site once installed:

# Set up some defaults:
mkdir project && cd project
wrt init

# Create an entry for January 1, 2019:
mkdir -p archives/2019/1/
nano archives/2019/1/1

# Publish HTML to project/public/
wrt render-all

Please see the App::WRT listing on MetaCPAN or the POD documentation in lib/App/WRT.pm in this repository for detailed instructions.

security

A cautionary note that, since wrt templates and entries can contain embedded Perl, running this code against untrusted input is effectively the same as executing an arbitrary script. There may be other issues with running it against an untrusted archive (I make no promises) but it's probably not worth worrying about them in light of the <perl> feature.

This shouldn't worry you if you're generating a static site of your own. Just don't (for example) create a service that uses it to publish sites for users you don't already trust to run code on your systems.

wrt-as-a-service might be something I explore in future, but it will need some tweaking first.

copying

wrt is copyright 2001-2022 Brennen Bearnes.

wrt 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; version 2 or 3 of the License.

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 http://www.gnu.org/licenses/