A very minimal markdown-based static website generator written in Rust. https://projects.mrtryhard.info/mrtryhard/rs-webmark

Alexandre Leblanc ec108cb7da Fixes #6 - Adds support for copiable resources. 5 lat temu
src ec108cb7da Fixes #6 - Adds support for copiable resources. 5 lat temu
.gitignore ec108cb7da Fixes #6 - Adds support for copiable resources. 5 lat temu
Cargo.lock 4dc7a56b1d Implement markdown compiler & program argument. 5 lat temu
Cargo.toml 4dc7a56b1d Implement markdown compiler & program argument. 5 lat temu
LICENSE.md 68f5c4f949 Move license and readme to root folder. 5 lat temu
README.md 68f5c4f949 Move license and readme to root folder. 5 lat temu
rs-webmark.drawio 68c52ff07f Introduce the file_listing. 5 lat temu

README.md

rs-webmark

A very minimal static site generator that converts Markdown to HTML files.

Use case

While developing my website, I went from a C# .NET Core implementation, then a C++ implementation. They included the full ordeal of features:

  • Managing articles (CRUD)
  • Users (for comments)
  • Categories

In the end, I simply noted that, what I really wanted was a static website for I have no use for all those features. So I started doing the HTML pages manually.

After documenting my trip to Japan I noticed how tiresome it was to write the markup manually and how each page were basically structure similarly.

Markdown to the rescue

I personnally enjoy the Markdown-Preview Enhanced for Visual Studio Code which works flawlessly to take notes, so I decided to use markdown for the purpose of my website.

Of course, some static site generator already exists, such as:

  • Hugo - Very complete but seems overwhelming for my use case.
  • Cobalt - Pretty close to what I want but again, where's the fun if I cannot do it from scratch* myself ? :)

Disclaimer

I wouldn't recommend this for production use. This is mostly my own little project I cannot guarantee that I'll support even if my website is built on it.

Usage

License

See LICENSE.md for complete license.

Contributions

All contributions are welcome. Evidently some contributions might be refused but don't take it personnally and let's work together for a solution.