Vyriy

@vyriy/ssg

Static Markdown site generator for Vyriy-style content sites.

Purpose

This package builds a static site from Markdown README.md files. It is intended for content-first sites that need HTML pages, section catalogs, MiniSearch data, featured home content, related links, sitemap, robots, and copied public assets without adopting a full framework.

Markdown rendering uses react-markdown with GitHub-flavored Markdown and rehype-highlight, so content supports tables, task lists, autolinks, and highlighted fenced code blocks.

Install

With npm:

npm install @vyriy/ssg

With Yarn:

yarn add @vyriy/ssg

CLI

Build a site from site into dist:

vyriy-ssg site --output dist

The package also exposes the short ssg command:

ssg site -o dist

Useful options:

  • --site-url <url> sets canonical URLs and sitemap locations.
  • --site-name <name> sets the built-in theme name.
  • --stylesheet <href> links a stylesheet instead of using the built-in CSS.
  • --stylesheet-file <path> inlines a stylesheet file.
  • --ga <id> adds a Google Analytics measurement ID.

Content

By default, the generator expects this shape:

site/
  home/README.md
  consulting/README.md
  docs/README.md
  blog/<slug>/README.md
  docs/<slug>/README.md
  examples/<slug>/README.md
  public/

Markdown files can include simple frontmatter:

---
title: Calm deployment
description: Deployment notes for calm static sites.
date: 2026-06-16
published: true
homePage: true
tags:
  - ssg
  - deployment
---

# Calm deployment

Page content.

API

import { buildStaticSite } from '@vyriy/ssg';

await buildStaticSite({
  contentPath: 'site',
  outputPath: 'dist',
  siteUrl: 'https://vyriy.dev',
});

Custom sections are supported:

await buildStaticSite({
  sections: [
    {
      path: 'articles',
      title: 'Articles',
    },
  ],
});

Set index: false when a section should generate individual pages and search data without its own paginated catalog.

Public API

The package exposes the following main surface:

  • buildStaticSite(options) builds the static site.
  • runSsgCli(args) runs the CLI programmatically.
  • parsePage(markdown) parses page frontmatter and fallback metadata.
  • renderMarkdown(markdown) renders Markdown through react-markdown, remark-gfm, and rehype-highlight.
  • renderSitemap(urls, siteUrl) renders sitemap XML.
  • renderRobotsTxt(siteUrl) renders robots.txt.

Related packages

  • @vyriy/html for full HTML document output.
  • @vyriy/static for serving generated static files.
  • @vyriy/config for explicit runtime and environment configuration.