/record-collector

A .NET 6.0 static site toolkit

Primary LanguageC#MIT LicenseMIT

record-collector.net

The Record Collector example and documentation web site is being filled with content and will have all the information on what the project is and does. Easiest starting point is to set up the repository locally and run the web project, see the getting started page for instructions.

Inspiration

This project is heavily inspired by Hugo and I try to be somewhat compatible with the same content structure and support parsing of TOML, YAML and JSON front matter.

Bright ideas

The content file layer is converted to C# lists and objects and then used in a regular ASP.NET Core MVC project which is also where you can work live on both content preview and templating. This means you now can use your existing ASP.NET MVC and C# skills creating static site templates!

In this setup the generation process work using the WebApplicationFactory from the Microsoft.AspNetCore.Mvc.Testing package so I don't have to fall back to a console application or custom web servers for crunching the files and templates which is the norm for static site generation. Feels a lot better to me and while keeping really fast generation times.

Installed packages

Built using .NET 6.0 (through 3.1 and 5.0) and with these packages and projects. Thank you!

Project License
YamlDotNet MIT
Tomlyn BSD-Clause 2
Markdig BSD-Clause 2
JetBrains Mono font SIL Open Font License 1.1
Tailwind CSS MIT
Hotwire MIT
Simple.css {} MIT
Html Agility Pack MIT

Other things such as Webpack are involved too but these are the ones I firstly referenced and then they in turn depend on other packages.

Quality control tools

Demo sites

The demo web site is generated and deployed with Netlify using their build-image.

Netlify Status

This other instance of the same web site is generated on push and deployed to Netlify using a GitHub Action.

Netlify Status

License

This project is licensed under the MIT license. See the LICENSE file for more info.

The name

The name is a tribute to the brightest and most sophisticated humans on the planet; the record collectors.