sharq

sharq is a minimal static rendering framework for landing pages and Markdown-driven blogs. It generates crawl-friendly HTML, keeps output on disk, and can scaffold a new site with a single command.

Published on npm as @bivabdas/sharq.

Features

• Markdown posts with frontmatter
• Static HTML output in public/
• On-demand post generation
• Index, archive, and sitemap generation
• Zero-dependency runtime on native Node.js APIs

Install

Create a new site:

npx @bivabdas/sharq create my-site

Install globally:

npm install -g @bivabdas/sharq

Install in an existing project:

npm install @bivabdas/sharq

CLI

sharq start
sharq dev
sharq build
sharq create my-site
create-sharq my-site

sharq build creates a fresh sharq/ folder with deployable static files:

sharq/
  index.html
  archive.html
  sitemap.xml
  assets/
  blog/

Content format

Posts live in content/*.md and use frontmatter:

---
title: Hello sharq
description: Your first sharq post.
date: 2026-04-04
author: You
tags: welcome, getting-started
---

# Hello sharq

This site was scaffolded with sharq.

Project structure

content/
templates/
public/
sharq.config.js

Configuration

export default {
  siteTitle: "My Site",
  siteDescription: "A sharq site",
  siteUrl: "https://example.com"
};

Publish checklist

• Set siteUrl in sharq.config.js
• Add your content in content/
• Customize templates in templates/
• Run npm run build
• Ship the generated sharq/ output with your hosting flow