Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 3.31 KB

README.md

File metadata and controls

120 lines (91 loc) · 3.31 KB
Raw
title description tags type author date
Ludicrosity
real fast.
zig,ssg,project
post
vortex
10/05/2024

Click Here to view this exact page rendered using Ludicrosity.

Writing a blog can be quite the demanding task if you're not equipped with the right tools and strategies. Enter Ludicrosity a static site generator written in Zig.

   __           _ _                    _ _         
  / / _   _  __| (_) ___ _ __ ___  ___(_) |_ _   _ 
 / / | | | |/ _` | |/ __| '__/ _ \/ __| | __| | | |
/ /__| |_| | (_| | | (__| | | (_) \__ \ | |_| |_| |
\____/\__,_|\__,_|_|\___|_|  \___/|___/_|\__|\__, |
                                             |___/
A static site generator in Zig

TODO

Its awesome but not perfect. Here's a list of things I need to get to at some point.

  • Fix tagging
  • Salient error messages
  • Command line arguments
  • Sorting Posts
  • Searching through posts
  • Making code more modular

Building Ludicrosity

All source code for ludicrosity is housed within one single src/marked.zig for ultimate simplicity. Currently we depend on one dependency md4c for markdown parsing. To build the project we expect the following source tree:


.
├── build.zig
├── md4c
└── src
    └── marked.zig

The project can be cloned and built using the following commands:


git clone [email protected]:vortex73/ludicrosity.git --recurse-submodules # pulls even the md4c dependency
zig build -Doptimize=ReleaseFast

Project Structure

Ludicrosity is highly opinionated. Which means you need to adhere to the following file structure strictly.


[project root]
├── assets
├── content
│   └── post1.md
│   └── post2.md
│   └── ...
├── css
│   └── style.css
├── rendered
├── tags
└── templates
    └── post.html
    └── tags.html
    └── snippets(coming soon)

Ludicrosity will read template files post.html and tags.html, and render the converted markdown into them and store them in the rendered/ directory. A file will be created for each tag listing all posts referencing that particular tag in the tags/ directory.

MetamatterTM

While YAML frontmatter is great, I wanted something distinctly unique and yet easy to parse to store the metadata. Inspired heavily from the Pandoc style of writing metadata, Ludicrosity uses its own frontmatter format called Metamatter. And its beautifully simple.


% title: Post0
% date: 24/11/1951
% author: mukesh
% type: post
% tags: fast,post,blog,portfolio

Thats it!

Templating Language? What's that?

Ludicrosity has limited templating capabilities at the moment.


<div class="content">
    <h1><!--title--></h1>
    <div class="meta">
        <ul>
            date: <!--date--><br>
            type: <!--type--><br>
            <ul>tags: <!--tags--></ul>
        </ul>
    </div>
    <!--BODY-->
</div>

Mention the tagname as per what was mentioned in the Metamatter block inside an HTML comment element. This will be substituted for the posts' actual metadata. <!--BODY--> is exclusively reserved for the body of the post.