No description

Find a file

Jack Stouffer 60d4b485fc fix cl compile warning		2024-11-07 11:55:48 -05:00
example	allow multiple tags to be replaced	2024-11-07 11:52:22 -05:00
.gitignore	everything done but docs	2024-11-03 23:35:36 -05:00
LICENSE.md	getting basic API structure	2024-10-27 21:15:16 -04:00
README.md	docs	2024-11-04 22:24:51 -05:00
simple-static-site.h	fix cl compile warning	2024-11-07 11:55:48 -05:00

README.md

Simple Static Site Generator

A simple, cross platform, code driven, single header file, static site generator for markdown based content.

Most of this code wasn't written by me, it's mostly base off of MD4C: http://github.com/mity/md4c

Project Goals

I need something that is

Stable.
- I can't STAND coming back to a project and having to redo all of the node dependencies anymore. I just need it TO WORK. This is just a project that WRITES HTML FILES.
Takes Markdown and generates static HTML from given HTML templates
Doesn't use complicated domain specific language or templating. The site's structure should be driven from code
Cross platform
UTF-8
Easy to use across projects
- No make, cmake, et. al.

A single-header-file, C11 compliant library is by far the easiest thing to make fit these requirements.

To use this library, just copy and paste the simple-static-site.h into your project.

Caveats

As this is meant to be a batch tool, not a fully featured application, there are some things to keep in mind:

Most errors are just asserted on, as this is the behavior you want anyway
This library just mallocs every time it needs a string and never calls free. If for some reason you're generating a site of many gigabytes than this will be an issue for you

Include

#include "simple-static-site.h"

In one, and only one, file do

#define STATIC_SITE_IMPLEMENTATION
#include "simple-static-site.h"

API

The docs for these functions are in the header file.

SSS_CHAR* sss_render_file(
    const SSS_CHAR* template,
    const SSS_CHAR* title,
    const SSS_CHAR* markdown
);

SSS_CHAR* sss_read_file(const SSS_CHAR* filename, SSS_SIZE* out_size);

int sss_write_to_file(const SSS_CHAR* filename, SSS_CHAR* cstr);

const SSS_CHAR** sss_get_files_in_folder(const SSS_CHAR* path, SSS_SIZE* out_size);

Usage

There's a larger example in the example folder.

main.c

#define STATIC_SITE_IMPLEMENTATION
#include "../simple-static-site.h"


int main()
{
    char* title = "Home";
    char* base_template = sss_read_file("templates/base.html", NULL);
    char* markdown_data = sss_read_file("content/home.md", NULL);

    char* html = sss_render_file(
        base_template,
        title,
        markdown_data
    );
    sss_write_to_file("build/home.html", html);
}

base.html

<!doctype html>
<html>
    <head>
        <title>{{ title }}</title>
    </head>
    <body>
        {{ markdown }}
    </body>
</html>

base.md

# This Is A Body Header

This is body content