grubby: static site generator for git repos written in Ruby
Grubby is a static site generator designed to create websites from Git repositories using Ruby. It operates on the principle of minimal customization, requiring little to no tinkering to function as intended. Kramdown serves as the default Markdown parser, though users are free to substitute it with another parser should they wish, though Grubby cannot guarantee the stability of such a change.
It is also mandatory that all Git repositories end with the .git extension; otherwise, the core repository index generation process will not work as expected. The only file that should be modified is the _config.yml file, where core settings such as domain and paths can be adjusted. Users are free to tweak the CSS, navigation links, and footer content by editing the style.css, _header.html, and _footer.html files respectively.
The default "repo index" file is named index.html and is generated at the root of the main directory. However, users have the option to rename this file by adjusting the corresponding setting in the _config.yml file. This guide is based on the assumption that the Git repositories are hosted using a form of shared hosting, specifically NearlyFreeSpeech.NET.
While the process is similar on a VPS, it is recommended to host Git repositories under the /home/public/git.sitename.org directory. To test Grubby, users can run a specific command, which will generate an individual repo website at /home/public/git.sitename.org/coolrepo along with an updated repo index (default index.html) at the root of the domain.
Further customization can be achieved by incorporating changes into the hooks/post-receive file or by using a global post-update mechanism to streamline the process for multiple projects.
Written by urgent.news from Lobsters's reporting — not their text. Machine-written — may contain errors; check the original before relying on it.