website

README

website

Yet another NIH static website framework.

The idea is to have a single website for ALL my stuff: blogs, projects, talks, random notes, etc.

Why?

For a long time, I've been willing to have simple project pages for my open source projects, integrated to my website/blog. The easiest way of doing that would be to write proper README.mds in the Git repositories and have them rendered and included to my website. This way both my website and the repositories would be proper documentation endpoints, with all the data synchronized. However, implementing such advanced features that require API interaction is not trivial in blogc. Or maybe I'm getting too old to implement parsers/renderers in C, who knows… But in the end it was easier to just slowly implement what I wanted in Go over the past few months. Also, the standard Go text/template library allows to easily handle a variety of post/page formats from the same base templates, which is something I suppose that I'll need.

The code is kinda generic (writing code that way is just stronger than me...), but that’s it: there’s no documentation neither usage examples, and my content repository is private. This program is open source, but if you decide to use it, you are on your own. There are some quite interesting code snippets in this codebae, though. Make sure to take a look if you like Go :-).

Some cool features

• Generation of project pages from GitHub READMEs.
• Generation of project API documentation, similar to Doxygen, but simpler, focused on C.
• Embedded default templates.
• Javascript/CSS assets downloaded directly from CDN to be hosted locally.
• Runner can rebuild output files when the binary is rebuilt or any source file changes.
• Supports groups of posts.
• Automatic generation of OpenGraph metadata and images.
• Atom feeds for the main blog and every group of posts.
• QR Code encoder.
• Go vanity import paths.
• textbundle and textpack support.
• Post-processing of generated files, such as compression, quantizing, minification, etc.

Versioning

This software won't ever receive an official release, but it uses the default version string generated by the Go compile during the build process. Example: v0.0.0-20241101101234-a1b2c3d4e5f6.

License

This code is released under a BSD 3-Clause License.