Skip to content

hyperpolymath/noteg-ssg

noteg-ssg

Overview

noteg-ssg is a satellite project in the hyperpolymath ecosystem that provides Model Context Protocol (MCP) adapters for 28 different static site generators across multiple programming languages.

This project integrates with the poly-ssg-mcp hub to provide a unified interface for working with various SSGs.

Key Features

  • 28 SSG Adapters - Support for SSGs written in Rust, Haskell, Elixir, Julia, Scala, and more

  • MCP Protocol - Standardised Model Context Protocol interface

  • Deno Runtime - All adapters run on Deno for consistent cross-platform execution

  • RSR Compliant - Follows Rhodium Standard Repository guidelines

Supported Static Site Generators

Adapter Language Description

babashka

Clojure

Babashka-based SSG

cobalt

Rust

Static site generator in Rust

coleslaw

Common Lisp

Lisp-based SSG

cryogen

Clojure

Static site generator for Clojure

documenter

Julia

Julia documentation generator

ema

Haskell

Haskell static site generator

fornax

F#

F# static site generator

franklin

Julia

Julia-based SSG with live editing

frog

Racket

Racket static blog generator

hakyll

Haskell

Hakyll static site generator

laika

Scala

Scala documentation tool

marmot

Crystal

Crystal-based SSG

mdbook

Rust

Rust book/documentation generator

nimble-publisher

Elixir

Nimble-based Elixir publisher

nimrod

Nim

Nim static site generator

orchid

Kotlin

Kotlin documentation generator

perun

Clojure

Clojure static site generator

pollen

Racket

Racket publishing system

publish

Swift

Swift static site generator

reggae

D

D language SSG

scalatex

Scala

Scala text processor

serum

Elixir

Simple static site generator for Elixir

staticwebpages

Julia

Julia static web pages

tableau

Elixir

Elixir static site generator

wub

Tcl

Tcl web framework

yocaml

OCaml

OCaml static site generator

zola

Rust

Fast static site generator in Rust

zotonic

Erlang

Erlang CMS and framework

Installation

Prerequisites

  • Deno runtime (v1.40+)

  • The specific SSG you want to use must be installed on your system

Setup

# Clone the repository
git clone https://github.com/hyperpolymath/noteg-ssg.git
cd noteg-ssg

Usage

Each adapter provides a standard MCP interface with common tools:

// Example: Using the Zola adapter
import { connect, tools } from './adapters/zola.js';

// Connect to verify Zola is installed
await connect();

// Use available tools
const result = await tools.find(t => t.name === 'init').execute({ name: 'my-site' });

Common Tools

All adapters typically provide these tools:

  • init - Initialize a new site

  • build - Build the static site

  • serve - Start a development server

  • check - Validate site configuration

  • version - Get the SSG version

Architecture

noteg-ssg (satellite)
    |
    +-- adapters/           # 28 MCP adapter implementations
    |   +-- zola.js
    |   +-- hakyll.js
    |   +-- ...
    |
    +-- Integrates with: poly-ssg-mcp (hub)

Ecosystem Position

  • This project: Satellite SSG adapter implementations

  • poly-ssg-mcp: Central hub providing unified MCP server

  • rhodium-standard-repositories: RSR compliance standard

Development

Prerequisites

  • Deno runtime

  • (Optional) just task runner

  • (Optional) Nix for reproducible environments

Running Tests

# Run all adapter tests
deno test adapters/

# Test a specific adapter
deno test adapters/zola.js

Adding New Adapters

  1. Create a new file in adapters/ following the existing pattern

  2. Export: name, language, description

  3. Implement: connect(), disconnect(), isConnected(), tools[]

  4. Add tests

See CONTRIBUTING.md for full guidelines.

Security

Please report security vulnerabilities through GitHub Security Advisories: https://github.com/hyperpolymath/noteg-ssg/security/advisories/new

See SECURITY.md for our full security policy.

License

This project is dual-licensed under:

  • MIT License

  • AGPL-3.0-or-later

See LICENSE.txt for details.

Contributing

Contributions are welcome! Please read our Contributing Guidelines and Code of Conduct before submitting.

About

Static site generator in the spirit of Ada Lovelace. Notes that compute.

Topics

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Sponsor this project

Packages

No packages published

Contributors 2

  •  
  •