Skip to content
This repository has been archived by the owner on Feb 10, 2024. It is now read-only.

mrtryhard/rs-webmark

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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.