ProjectsFebruary 12, 2025

Building a Compiler for Markdown

Overview

MarkLeft is a powerful and flexible tool designed to extend the capabilities of traditional Markdown-to-HTML compilers. It introduces additional syntax and features to enhance the expressiveness and functionality of Markdown documents.

MarkLeft is a work in progress and is currently under development. Please check back for updates and new features. You are still free to use it and contribute to it.

Features

Superfast: MarkLeft is designed to be fast and efficient, processing Markdown files quickly and generating HTML output in an instant.
Extensible: MarkLeft is highly extensible, allowing users to define custom syntax and features to suit their needs.
Customizable: MarkLeft provides a range of options and settings to customize the output, including themes, styles, and more.(coming soon)

Prerequisites

Ruby >~ 3.2.4
Bundler =2.6.3

Installation

To install MarkLeft, clone the repository and navigate to the project directory:

Gem

gem install markleft

Repository

git clone git@github.com:greeenboi/markdown-superset-compiler.git

Running the Converter

Using Gem

markleft

Using markleft-main.rb

The markleft-main.rb file is a simple script that reads a Markdown file, tokenizes it, parses it, and generates HTML output.

Run the Script
```
ruby lib/markleft.rb
```
Follow the prompts to select a Markdown file and process it.

Example

Given a sample Markdown file sample.md:


    This is a sample *Markdown* file
**bold** yippee!

Recent projects

The Eden Project

What if music wasn't so inaccessible..

Read case study

Run over a Deer

A Silly little game based on the hit movie Over The Hedge

Read case study

Just a Walkthrough

Framework-agnostic onboarding walkthrough / product tour library with optional React provider & Tailwind/shadcn support.

Read case study

Suvan GSgreeenboiGreenArcadeSuvan GSgreeenboiGreenArcadeSuvan GSgreeenboi