smirky 1.0.0 → 1.0.1

package/README.md

@@ -1,203 +1,186 @@
-Below is a clean, professional, publication‑ready **README.md** for Smirky.  
-No emojis. No fluff. Just a clear, well‑structured document that positions Smirky as a serious static site generator with a Tailwind‑based default theme and Fabform integration.
+# Smirky — Minimalist Static Website Generator
 
-You can drop this directly into your repository.
+Smirky is a minimalist static website generator for people who just want to write Markdown and get a website — no ceremony, no plugins, no magic.
+
+It is perfect for building blogs, landing pages, or any static site quickly.
 
 ---
 
-# Smirky  
-A lightweight, theme‑friendly static website generator powered by Markdown and Node.js. Smirky focuses on clarity, simplicity, and extensibility, making it an ideal choice for blogs, documentation sites, and small business websites.
+## Why Smirky?
 
-Smirky ships with a default Tailwind CSS theme that includes a fully functional contact form powered by the Fabform backend service. You can use the included theme as‑is or create your own custom themes with complete control over layout, styling, and structure.
+* Write Markdown and get a website
+* Supports tags in Markdown posts
+* Minimal templates with header, navbar, footer, and content
+* Blog posts and tag pages generated automatically
+* Assets copied automatically
+* No complex configuration
+* Works with [Fabform.io](https://fabform.io) for contact forms
 
 ---
 
 ## Features
 
-- Markdown‑based content and pages  
-- Clean, minimal templating system  
-- Theme‑driven architecture  
-- Built‑in blog system with tags  
-- Tailwind CSS default theme  
-- Fabform‑powered contact form integration  
-- Zero configuration required  
-- Fast builds and simple folder structure  
+* Simple Markdown pages (`pages/`)
+* Blog posts (`content/`) with tags
+* Tag pages (`/tags/`) and blog index (`/blog/`)
+* Clean templates and partials (`theme/`)
+* Static assets copied automatically (`theme/assets/`)
+* Contact forms via [Fabform.io](https://fabform.io)
+* Generates everything in `dist/` for deployment
 
 ---
 
-## Folder Structure
-
-A typical Smirky project looks like this:
-
-```
-project/
-  smirky/
-    smirky.js
-  content/
-  pages/
-  theme/
-    layout.html
-    index.html
-    page.html
-    post.html
-    blog.html
-    tags.html
-    partials/
-      head.html
-      navbar.html
-      footer.html
-      blog_post_card.html
-      tag_pill.html
-    assets/
-    site.json
-  dist/
-```
+## Getting Started
 
----
+1. Install Smirky globally or as a dev dependency:
 
-## Installation
+```bash
+# global installation
+npm install -g smirky
 
-Smirky can be installed locally within your project:
-
-```
-npm install smirky
+# or as a dev dependency in your project
+npm install --save-dev smirky
 ```
 
-Or used directly via npx:
+2. Create your project structure:
 
 ```
-npx smirky
+my-site/
+├── pages/          # Static pages in Markdown
+├── content/        # Blog posts in Markdown
+├── theme/          # Optional: custom templates, partials, assets
+└── package.json
 ```
 
----
+3. Add your pages to `pages/` and your blog posts to `content/`:
 
-## Usage
+**Example page**: `pages/about.md`
 
-Smirky is designed to be simple and predictable. Once your content, pages, and theme are in place, you can build your site with a single command.
+```md
+---
+title: About
+slug: about
+---
 
-### Build your site
+## About Smirky
 
+Smirky is a minimalist static site generator. Write Markdown, run Smirky, done.
 ```
-npm run build
-```
-
-This generates a fully static website inside the `dist/` directory.
-
-### Development mode
 
-If you prefer to rebuild manually during development:
-
-```
-npm run dev
-```
+**Example blog post with tags**: `content/my-first-post.md`
 
+```md
+---
+title: My First Post
+date: 2026-01-08
+tags:
+  - JavaScript
+  - Static Sites
 ---
 
-## Content and Pages
+Hello! This is my first blog post powered by Smirky.
+```
 
-Smirky uses two types of Markdown files:
+> The `tags` field lets Smirky automatically generate tag pages and link posts to them.
 
-### Pages  
-Stored in `/pages`, each file becomes a standalone route:
+4. Build your site:
 
-```
-/pages/about.md → /about/index.html
+```bash
+npm run build
 ```
 
-### Blog Posts  
-Stored in `/content`, each file becomes a blog post:
+> **Note:** Make sure your `package.json` has this script:
 
-```
-/content/my-first-post.md → /blog/my-first-post/index.html
+```json
+"scripts": {
+  "build": "smirky"
+}
 ```
 
-Both support front‑matter:
-
-```yaml
----
-title: About Us
-slug: about
-tags: [company, mission]
----
-```
+The generated site will be in the `dist/` folder. Deploy it anywhere: Netlify, Vercel, GitHub Pages, etc.
 
 ---
 
-## Default Theme
+## How Themes Work
 
-Smirky includes a Tailwind CSS theme located in the `/theme` directory. It provides:
+Smirky uses templates and partials to assemble your pages:
 
-- Responsive layout  
-- Navigation bar  
-- Blog index and post templates  
-- Tag pages  
-- Footer  
-- Contact form powered by Fabform  
+* `layout.html` — main wrapper
+* `index.html` — home page
+* `page.html` — static pages
+* `post.html` — individual blog posts
+* `blog.html` — blog index and tag pages
+* `tags.html` — tag index
 
-### Fabform Integration
+Partials are reusable components:
 
-The default theme includes a ready‑to‑use contact form that posts directly to Fabform.  
-To enable it, update the form action in your theme’s HTML:
-
-```
-<form action="https://fabform.io/f/your-form-id" method="POST">
-```
+* `head.html` — meta tags, CSS
+* `navbar.html` — navigation bar
+* `footer.html` — footer content
+* `blog_post_card.html` — blog summary card
+* `tag_pill.html` — tag label
 
-No backend code is required.
+Variables such as `{{ title }}`, `{{ content }}`, `{{ tag_pills }}`, `{{ site_title }}` are replaced automatically.
 
 ---
 
-## Creating Your Own Themes
+## Tags
 
-Smirky is fully theme‑driven. A theme consists of:
+* Tags are defined in Markdown frontmatter with `tags: [Tag1, Tag2]`
+* Smirky generates:
 
-- HTML templates  
-- Partials  
-- Assets (CSS, JS, images)  
-- A `site.json` configuration file  
+  * `/tags/` — index of all tags
+  * `/tags/{tag}/` — all posts with that tag
 
-You can create a new theme by duplicating the default theme and modifying:
+Tag pages automatically list posts that have the tag. Example URL:
 
-- Layout structure  
-- Tailwind classes or CSS framework  
-- Partials  
-- Blog card design  
-- Tag pill design  
+```
+/tags/javascript/
+```
 
-Smirky does not enforce any styling framework. You may use Tailwind, Bootstrap, custom CSS, or anything else.
+---
 
-### Required template placeholders
+## Contact Forms (Fabform.io)
 
-Every theme must include the following tokens:
+Smirky works with [Fabform.io](https://fabform.io) for contact forms without a backend.
 
+**Example Contact Form:**
+
+```html
+<form
+  action="https://fabform.io/f/FORM_ID"
+  method="POST"
+>
+  <input type="text" name="name" placeholder="Your name" required />
+  <input type="email" name="email" placeholder="Your email" required />
+  <textarea name="message" placeholder="Your message"></textarea>
+  <button type="submit">Send</button>
+</form>
 ```
-{{ head }}
-{{ navbar }}
-{{ footer }}
-{{ content }}
-{{ title }}
-```
 
-Smirky replaces these during the build process.
+* Replace `FORM_ID` with your Fabform ID
+* Works directly on your static site
+* No server, no backend
+
+[Visit Fabform.io](https://fabform.io)
 
 ---
 
 ## Deployment
 
-Since Smirky outputs a fully static site, you can deploy the `dist/` folder to any static hosting provider:
+After running `npm run build`, deploy the `dist/` folder to any static host:
 
-- Netlify  
-- Vercel  
-- GitHub Pages  
-- Cloudflare Pages  
-- AWS S3  
-- Any static file server  
+* [Netlify](https://www.netlify.com/)
+* [Vercel](https://vercel.com/)
+* [Cloudflare Pages](https://pages.cloudflare.com/)
+* [GitHub Pages](https://pages.github.com/)
 
 ---
 
-## License
+## Philosophy
+
+Smirky is for people who want simple static sites. No plugins, no hidden configs, no ceremony.
+
+**Write Markdown, run Smirky, done.**
 
-MIT License  
-Copyright © Geoffrey Callaghan
 
----

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "smirky",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A tiny, theme-friendly static website generator powered by Markdown.",
   "type": "module",
   "scripts": {

package/dist/about/index.html

@@ -1,60 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-  <link rel="stylesheet" href="/assets/site.css">
-
-
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-
-  <title>About - My Site</title>
-  <meta name="description" content="A simple static site powered by a KISS SSG." />
-</head>
-<body class="bg-slate-50 text-slate-900">
-
-  <nav class="bg-white shadow-sm">
-  <div class="max-w-5xl mx-auto px-4 h-16 flex items-center justify-between">
-
-    <a href="/" class="text-xl font-bold text-indigo-600">
-      My Site
-    </a>
-
-    <div class="space-x-6 text-sm font-medium">
-      <a href="/about/" class="text-indigo-600 font-semibold">About</a>
-      <a href="/contact/" class="text-slate-700 hover:text-slate-900">Contact</a>
-      <a href="/blog/" class="text-slate-700 hover:text-slate-900">Blog</a>
-      <a href="/tags/" class="text-slate-700 hover:text-slate-900">Tags</a>
-    </div>
-
-  </div>
-</nav>
-
-
-
-  <main class="max-w-5xl mx-auto px-4 py-10">
-    <article class="prose prose-slate max-w-none">
-  <h1>About</h1>
-  <h1>About This Site</h1>
-<p>This website is built using a tiny static site generator that follows the KISS principle.</p>
-<p>Everything is intentionally simple:</p>
-<ul>
-<li>No complex frameworks  </li>
-<li>No heavy build tools  </li>
-<li>No unnecessary features</li>
-</ul>
-<p>Just clean Markdown, simple templates, and fast static HTML output.</p>
-
-</article>
-
-
-  </main>
-
-  <footer class="mt-12 border-t border-slate-200 py-6 text-sm text-slate-500 text-center">
-  © 2026 My Site
-</footer>
-
-
-
-</body>
-</html>
-

package/dist/assets/input.css

@@ -1,92 +0,0 @@
-@import "tailwindcss";
-
-/* ---------------------------
-   Global Markdown Typography
-   Tailwind v4 — No Config File
----------------------------- */
-
-/* Headings */
-h1 {
-  @apply text-4xl font-bold leading-tight mt-8 mb-4;
-}
-
-h2 {
-  @apply text-3xl font-semibold leading-snug mt-6 mb-3;
-}
-
-h3 {
-  @apply text-2xl font-semibold leading-snug mt-5 mb-2;
-}
-
-h4 {
-  @apply text-xl font-semibold mt-4 mb-2;
-}
-
-h5 {
-  @apply text-lg font-medium mt-3 mb-2;
-}
-
-h6 {
-  @apply text-base font-medium mt-2 mb-2;
-}
-
-/* Paragraphs */
-p {
-  @apply text-base leading-relaxed mb-4;
-}
-
-/* Links */
-a {
-  @apply text-blue-600 underline hover:text-blue-800;
-}
-
-/* Images */
-img {
-  @apply rounded-lg my-4;
-}
-
-/* Lists */
-ul {
-  @apply list-disc pl-6 mb-4;
-}
-
-ol {
-  @apply list-decimal pl-6 mb-4;
-}
-
-li {
-  @apply mb-1;
-}
-
-/* Blockquotes */
-blockquote {
-  @apply border-l-4 border-gray-300 pl-4 italic text-gray-700 my-4;
-}
-
-/* Code blocks */
-pre {
-  @apply bg-gray-900 text-gray-100 p-4 rounded-lg overflow-x-auto my-4;
-}
-
-code {
-  @apply bg-gray-100 text-red-600 px-1 py-0.5 rounded;
-}
-
-/* Horizontal rule */
-hr {
-  @apply border-gray-300 my-8;
-}
-
-/* Tables */
-table {
-  @apply w-full border-collapse my-6;
-}
-
-th {
-  @apply border-b font-semibold p-2 text-left;
-}
-
-td {
-  @apply border-b p-2;
-}
-