Pageling

<!-- Copyright © 2021–2022 Tirifto

SPDX-License-Identifier: CC0-1.0 -->

Pageling is a naïve static site generator with support for multilingual outputs. It aims to be modular and easy to use. It is intended primarily for smaller, otherwise handcrafted websites.

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

Installation

Dependencies

• Raku compiler (such as Rakudo)
• TOML
• Getopt::Long
• File::Find

For the manual viewing functionality:

• Pod::To::HTML
• xdg-utils

And in order to run the tests:

• File::Temp

Automatic installation

There is a script called install.raku provided, which will attempt to install Pageling on your system. To run it, type raku install.raku, possibly followed by these options if you need them:

• --no-manual – Do not include a HTML manual in the installation.
• --prefix [PREFIX] – Where to place the appropriate directories bin and share, into which Pageling will be installed. By default, this is set to .local in your home directory.

For example, if you’d like to make Pageling accessible to all the users of your system, on some systems you might want to run the script like so:

raku install.raku --prefix /usr

You should be able to run the command pageling in your console now! If not, please make sure that the directory with the executable script is in your PATH environment variable. (~/.local/bin or [PREFIX]/bin if you changed it.)

Manual installation

Technically an installation isn’t really necessary; Pageling is a largely self-contained script that may be run from anywhere on your file system. To run it without an installation, use this command:

raku pageling.raku

If you wish to run it as an ordinary command, just copy it to some directory in your PATH and rename it as you please.

Please note that if you do this by hand, Pageling won’t be able to open the manual for you, but you can still do that by yourself. To export the manual into HTML (viewable in a web browser), use the following command:

raku --doc=HTML doc/manual.rakudoc > [FILE]

Where [FILE] stands for the filename of the resulting HTML document. (It’s a good idea to end that with .html.) Once you have the file, you may keep it wherever you like.

Testing

Once you’ve got all the dependencies in place, you can run the provided tests to see if Pageling works properly on your system. You should be running those from Pageling’s root directory.

There are several files with the extension .t located in various sub-directories of the directory t. You can have Raku interpret those to run their associated tests. Alternatively, if you have the testing tool prove6 installed, you may run all of them by simply executing prove6 t.

Contributing

Both the development and the ambitions of Pageling are very casual. If you’d like to contribute, you are encouraged to get in touch. Just dropping a patch might work fine, too, but there’s no telling in advance.

Whenever you do darcs replace, please use [A-Za-z0-9$@%&*-] as the token characters.