@terrymooreii/sia 1.0.2 → 2.0.0

package/lib/templates.js

@@ -0,0 +1,249 @@
+import nunjucks from 'nunjucks';
+import { join, dirname } from 'path';
+import { existsSync } from 'fs';
+import { fileURLToPath } from 'url';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+/**
+ * Format a date
+ */
+function dateFilter(date, format = 'long') {
+  if (!date) return '';
+  
+  const d = new Date(date);
+  
+  if (isNaN(d.getTime())) return '';
+  
+  const formats = {
+    short: { month: 'short', day: 'numeric', year: 'numeric' },
+    long: { month: 'long', day: 'numeric', year: 'numeric' },
+    iso: null,
+    rss: null,
+    year: { year: 'numeric' },
+    month: { month: 'long', year: 'numeric' },
+    time: { hour: 'numeric', minute: '2-digit' },
+    full: { weekday: 'long', month: 'long', day: 'numeric', year: 'numeric' }
+  };
+  
+  if (format === 'iso') {
+    return d.toISOString().split('T')[0];
+  }
+  
+  // RSS date format (RFC 822)
+  if (format === 'rss') {
+    return d.toUTCString();
+  }
+  
+  const options = formats[format] || formats.long;
+  return d.toLocaleDateString('en-US', options);
+}
+
+/**
+ * Generate a slug from a string
+ */
+function slugFilter(str) {
+  if (!str) return '';
+  return str
+    .toLowerCase()
+    .replace(/[^\w\s-]/g, '')
+    .replace(/[\s_-]+/g, '-')
+    .replace(/^-+|-+$/g, '');
+}
+
+/**
+ * Get excerpt from content
+ */
+function excerptFilter(content, length = 200) {
+  if (!content) return '';
+  
+  // Strip HTML tags
+  const text = content.replace(/<[^>]+>/g, '');
+  
+  if (text.length <= length) return text;
+  
+  // Find last space before limit
+  const truncated = text.substring(0, length);
+  const lastSpace = truncated.lastIndexOf(' ');
+  
+  return truncated.substring(0, lastSpace) + '...';
+}
+
+/**
+ * Limit array items
+ */
+function limitFilter(arr, count) {
+  if (!Array.isArray(arr)) return arr;
+  return arr.slice(0, count);
+}
+
+/**
+ * Skip array items
+ */
+function skipFilter(arr, count) {
+  if (!Array.isArray(arr)) return arr;
+  return arr.slice(count);
+}
+
+/**
+ * Get word count
+ */
+function wordCountFilter(content) {
+  if (!content) return 0;
+  const text = content.replace(/<[^>]+>/g, '');
+  return text.split(/\s+/).filter(word => word.length > 0).length;
+}
+
+/**
+ * Estimate reading time
+ */
+function readingTimeFilter(content, wordsPerMinute = 200) {
+  const words = wordCountFilter(content);
+  const minutes = Math.ceil(words / wordsPerMinute);
+  return minutes === 1 ? '1 min read' : `${minutes} min read`;
+}
+
+/**
+ * Group items by a property
+ */
+function groupByFilter(arr, key) {
+  if (!Array.isArray(arr)) return {};
+  
+  return arr.reduce((groups, item) => {
+    const value = item[key];
+    if (!groups[value]) {
+      groups[value] = [];
+    }
+    groups[value].push(item);
+    return groups;
+  }, {});
+}
+
+/**
+ * Sort array by property
+ */
+function sortByFilter(arr, key, order = 'asc') {
+  if (!Array.isArray(arr)) return arr;
+  
+  return [...arr].sort((a, b) => {
+    const aVal = a[key];
+    const bVal = b[key];
+    
+    if (aVal instanceof Date && bVal instanceof Date) {
+      return order === 'asc' ? aVal - bVal : bVal - aVal;
+    }
+    
+    if (typeof aVal === 'string' && typeof bVal === 'string') {
+      return order === 'asc' 
+        ? aVal.localeCompare(bVal) 
+        : bVal.localeCompare(aVal);
+    }
+    
+    return order === 'asc' ? aVal - bVal : bVal - aVal;
+  });
+}
+
+/**
+ * Filter items where property matches value
+ */
+function whereFilter(arr, key, value) {
+  if (!Array.isArray(arr)) return arr;
+  return arr.filter(item => item[key] === value);
+}
+
+/**
+ * Filter items that have a tag
+ */
+function withTagFilter(arr, tag) {
+  if (!Array.isArray(arr)) return arr;
+  const normalizedTag = tag.toLowerCase();
+  return arr.filter(item => 
+    item.tags && item.tags.some(t => t.toLowerCase() === normalizedTag)
+  );
+}
+
+/**
+ * JSON stringify for debugging
+ */
+function jsonFilter(obj, spaces = 2) {
+  return JSON.stringify(obj, null, spaces);
+}
+
+/**
+ * Create and configure the Nunjucks environment
+ */
+export function createTemplateEngine(config) {
+  // Set up template paths - user layouts first, then defaults
+  const templatePaths = [];
+  
+  // User's custom layouts
+  if (existsSync(config.layoutsDir)) {
+    templatePaths.push(config.layoutsDir);
+  }
+  
+  // User's custom includes
+  if (existsSync(config.includesDir)) {
+    templatePaths.push(config.includesDir);
+  }
+  
+  // Default templates from the package
+  const defaultTemplatesDir = join(__dirname, '..', 'defaults');
+  templatePaths.push(join(defaultTemplatesDir, 'layouts'));
+  templatePaths.push(join(defaultTemplatesDir, 'includes'));
+  templatePaths.push(join(defaultTemplatesDir, 'pages'));
+  
+  // Create the environment
+  const env = nunjucks.configure(templatePaths, {
+    autoescape: true,
+    noCache: true,
+    throwOnUndefined: false
+  });
+  
+  // Add custom filters
+  env.addFilter('date', dateFilter);
+  env.addFilter('slug', slugFilter);
+  env.addFilter('excerpt', excerptFilter);
+  env.addFilter('limit', limitFilter);
+  env.addFilter('skip', skipFilter);
+  env.addFilter('wordCount', wordCountFilter);
+  env.addFilter('readingTime', readingTimeFilter);
+  env.addFilter('groupBy', groupByFilter);
+  env.addFilter('sortBy', sortByFilter);
+  env.addFilter('where', whereFilter);
+  env.addFilter('withTag', withTagFilter);
+  env.addFilter('json', jsonFilter);
+  
+  return env;
+}
+
+/**
+ * Render a template with data
+ */
+export function renderTemplate(env, templateName, data) {
+  try {
+    return env.render(templateName, data);
+  } catch (err) {
+    console.error(`Error rendering template "${templateName}":`, err.message);
+    throw err;
+  }
+}
+
+/**
+ * Render a string template (for content with Nunjucks syntax)
+ */
+export function renderString(env, content, data) {
+  try {
+    return env.renderString(content, data);
+  } catch (err) {
+    console.error('Error rendering string template:', err.message);
+    throw err;
+  }
+}
+
+export default {
+  createTemplateEngine,
+  renderTemplate,
+  renderString
+};
+

package/package.json

@@ -1,26 +1,41 @@
 {
   "name": "@terrymooreii/sia",
-  "version": "1.0.2",
-  "description": "",
-  "main": "index.js",
-  "scripts": {
-    "lint": "npx prettier . --write"
+  "version": "2.0.0",
+  "description": "A simple, powerful static site generator with markdown, front matter, and Nunjucks templates",
+  "main": "lib/index.js",
+  "bin": {
+    "sia": "./bin/cli.js"
   },
   "type": "module",
-  "author": "",
-  "license": "ISC",
-  "bin": {
-    "sia": "./lib/index.js"
+  "scripts": {
+    "dev": "node bin/cli.js dev",
+    "build": "node bin/cli.js build",
+    "new": "node bin/cli.js new"
   },
+  "keywords": [
+    "static-site-generator",
+    "ssg",
+    "markdown",
+    "nunjucks",
+    "blog"
+  ],
+  "author": "",
+  "license": "MIT",
   "dependencies": {
-    "feed": "^4.2.2",
-    "find-up": "^7.0.0",
-    "forever": "^4.0.3",
+    "chalk": "^5.3.0",
+    "chokidar": "^3.5.3",
+    "commander": "^11.1.0",
     "gray-matter": "^4.0.3",
     "highlight.js": "^11.9.0",
-    "markdown-it": "^14.0.0",
+    "js-yaml": "^4.1.0",
+    "marked": "^11.1.1",
+    "marked-emoji": "^2.0.2",
+    "marked-highlight": "^2.1.0",
     "nunjucks": "^3.2.4",
-    "prettier": "3.2.1",
-    "slugify": "^1.6.6"
+    "prompts": "^2.4.2",
+    "ws": "^8.16.0"
+  },
+  "engines": {
+    "node": ">=18.0.0"
   }
 }

package/readme.md

@@ -1,115 +1,264 @@
-# Sia blog
+# Sia
 
-Sia is static site generator
+A simple, powerful static site generator built with JavaScript. Similar to Eleventy/11ty, Sia supports markdown, front matter, Nunjucks templates, and more.
 
-## Installation
+## Features
 
-```
-npm install --save-dev @terrymooreii/sia
+- **Markdown & Front Matter** - Write content in markdown with YAML front matter
+- **Nunjucks Templates** - Flexible templating with includes and layouts
+- **Multiple Content Types** - Blog posts, pages, and notes (tweet-like short posts)
+- **Tags & Categories** - Organize content with tags, auto-generated tag pages
+- **Pagination** - Built-in pagination for listing pages
+- **Image Support** - Automatic image copying and organization
+- **Live Reload** - Development server with hot reloading
+- **Dark Mode** - Built-in light/dark theme with toggle
+- **RSS Feed** - Automatic RSS feed generation
+- **YAML/JSON Config** - Flexible configuration options
+
+## Quick Start
+
+### Create a New Site
+
+```bash
+# Install Sia globally
+npm install -g sia
+
+# Create a new site
+sia init my-blog
+
+# Or create in current directory
+sia init
+
+# Non-interactive mode
+sia init my-blog --yes
 ```
 
-After installation run the following command in a new node repo
+### Development
 
+```bash
+cd my-blog
+npm install
+npm run dev
 ```
-sia init
+
+Visit `http://localhost:3000` to see your site.
+
+### Production Build
+
+```bash
+npm run build
 ```
 
-This will install the nunjucks template files, some base css and a shell `index.html`
+The output will be in the `dist/` folder, ready to deploy to any static hosting.
 
-It also add the `.siarc.js` config file to the root of your project.
+## Creating Content
 
-The `.siarc.js` file contains two sections.  One for configuing your site information. The second is to configure the app's folders, numjucks template, and markdown configutation. 
+### New Blog Post
 
+```bash
+npx sia new post "My Post Title"
+```
 
-## Adding pages and posts
+Creates a new markdown file in `src/posts/` with front matter template.
 
-The easist way to add a new page or a post to your site is to run the following command
+### New Page
 
+```bash
+npx sia new page "About Me"
 ```
-sia new post new-post-name
+
+Creates a new page in `src/pages/`.
+
+### New Note
+
+```bash
+npx sia new note "Quick thought"
 ```
 
-This will create a new folder in the `content` folder called `new-post-name` and add a shell `index.html`
+Creates a short note in `src/notes/`.
 
-You can do the same thing to create a new page
+## Project Structure
 
 ```
-sia new post new-post-name
+my-site/
+├── _config.yml          # Site configuration
+├── src/
+│   ├── posts/           # Blog posts (markdown)
+│   ├── pages/           # Static pages
+│   ├── notes/           # Short notes/tweets
+│   └── images/          # Images
+├── _layouts/            # Custom layouts (optional)
+├── _includes/           # Custom includes (optional)
+├── styles/              # Custom CSS (optional)
+└── dist/                # Generated output
 ```
 
-The difference between pages and posts is that during the build process sia keeps tack of all posts and generate a post list page at the url `/blog`
+## Configuration
+
+Edit `_config.yml` to customize your site:
+
+```yaml
+site:
+  title: "My Blog"
+  description: "A personal blog"
+  url: "https://example.com"
+  author: "Your Name"
+
+input: src
+output: dist
+
+collections:
+  posts:
+    path: posts
+    layout: post
+    permalink: /blog/:slug/
+    sortBy: date
+    sortOrder: desc
+  pages:
+    path: pages
+    layout: page
+    permalink: /:slug/
+  notes:
+    path: notes
+    layout: note
+    permalink: /notes/:slug/
+
+pagination:
+  size: 10
+
+server:
+  port: 3000
+```
 
-New pages and post will have config area at the top that tell sia how to handle the page and post.  All properties expect the image is required. The image is used to generate the page's `og:image`.  If its not present we will use the `blogs_image`.
+## Front Matter
 
-```
----
+Each markdown file can have YAML front matter:
 
-template: post
-title: Page title
-created_at: 2024-01-12 16:00:00-5:00
-description: Testing out some markdown
+```yaml
+---
+title: "My Post Title"
+date: 2024-12-17
+tags: [javascript, tutorial]
+layout: post
+permalink: /custom-url/
+draft: true          # Excludes from build
+excerpt: "Custom excerpt text"
 ---
 ```
 
-- `template` is the nunjucks template located in `src/_partials`
-- `title` is the post title and used in the blog posts list page
-- `create_at` is the date of the post
-- `description` a short description of the post
+### Supported Fields
 
-Not ready to publish a post?  Add `draft: true`
+| Field | Description |
+|-------|-------------|
+| `title` | Post/page title |
+| `date` | Publication date |
+| `tags` | Array of tags |
+| `layout` | Template to use |
+| `permalink` | Custom URL |
+| `draft` | If true, excluded from build |
+| `excerpt` | Custom excerpt |
 
-## Build
+## Templates
 
-To build the site run 
+Sia uses Nunjucks for templating. Templates are loaded from:
 
-```
-sia build
-```
+1. `_layouts/` - Your custom layouts
+2. `_includes/` - Your custom includes
+3. Default templates (provided by Sia)
 
-This will parse all markdown files and then numjucks. 
-The default output folder is `/public`
+### Available Variables
 
-The build command will also copy all `assets`, `js` and `css` to the `/public` folder.  If a post or a page folder contain other files other than markdown then those files will also get moved to the `/public/<folder>`.  This makes it easy to organize a single page or posts with custom js, css, or images.
+In templates, you have access to:
 
-All markdown files will get parsed with `markdown-it` and you can add additional `markdown-it` plugins in the `.siarc.js` file.
+- `site` - Site configuration (title, description, etc.)
+- `page` - Current page data
+- `content` - Rendered markdown content
+- `collections` - All content collections
+- `tags` - Tag data with counts
+- `allTags` - Array of all tags
 
-## Plugins
+### Custom Filters
 
-There are lots of plugins that you can use in sia to extend [markdown-it](https://github.com/markdown-it/markdown-it) and in turn sia.  Just install the plugin, import itto your `.siarc.js` file and then add it to the `app.markdown.plugins` array.  
+| Filter | Description | Example |
+|--------|-------------|---------|
+| `date` | Format dates | `{{ page.date \| date('long') }}` |
+| `slug` | Generate URL slug | `{{ title \| slug }}` |
+| `excerpt` | Get excerpt | `{{ content \| excerpt(200) }}` |
+| `limit` | Limit array | `{{ posts \| limit(5) }}` |
+| `readingTime` | Estimate reading time | `{{ content \| readingTime }}` |
+| `withTag` | Filter by tag | `{{ posts \| withTag('javascript') }}` |
 
-## Local developement 
+## Customization
 
-Currently these are the apps that I use on my blog for local development and building
+### Custom Layouts
 
-```
-"scripts": {
-  "serve": "npx http-server public",
-  "watch": "forever --watchDirectory ./src -w ./node_modules/@terrymooreii/sia/lib/index.js build",
-  "dev": "concurrently --kill-others \"npm run watch\" \"npm run serve\"",
-  "clean": "rm -rf public",
-  "build": "sia build"
-},
-```
+Create `_layouts/post.njk` to override the default post layout:
 
+```njk
+{% extends "base.njk" %}
+
+{% block content %}
+<article>
+  <h1>{{ page.title }}</h1>
+  {{ content | safe }}
+</article>
+{% endblock %}
 ```
-npm install forever concurrently http-server
+
+### Custom Styles
+
+Create `styles/main.css` to override default styles. Your custom CSS will be used instead of the default theme.
+
+### Custom Includes
+
+Create `_includes/header.njk` to override the header, etc.
+
+## CLI Commands
+
+```bash
+# Create a new site
+sia init [directory]
+sia init my-blog --yes  # Non-interactive
+
+# Start development server
+sia dev
+sia dev --port 8080
+
+# Build for production
+sia build
+sia build --clean
+
+# Create new content
+sia new post "Title"
+sia new page "Title"
+sia new note "Content"
 ```
 
-Coming soon will be a simple way to run a local web server to see live updates to posts and pages as you work via the `sia` command.
+## Upgrading
+
+If you installed Sia as a dependency (recommended):
 
-## Templates and site configuration
+```bash
+# Check for updates
+npm outdated
 
-All `njk` files are in a simple default state to generate a simple and clean website.  You can modifiy the html in these file to customer your site to look how you want.
+# Upgrade to latest
+npm update sia
+
+# Or upgrade to specific version
+npm install sia@2.0.0
+```
 
-If you make something cool please let me know.
+## Deployment
 
+After running `npm run build`, deploy the `dist/` folder to:
 
-## Todo
+- **Netlify** - Drag and drop or connect to Git
+- **Vercel** - Import project
+- **GitHub Pages** - Push to `gh-pages` branch
+- **Cloudflare Pages** - Connect repository
+- **Any static host** - Upload the `dist/` folder
 
-This is a list of items that still need to be tackled
+## License
 
-[ ] Better error handling
-[ ] Pagination
-[ ] `sia init` to generate a new site and clean up of the initial theme
-[ ] While pages and longer blog posts are great, i would like to add a mircoblogging feed to the site.
-[ ] Github action to publish new version to npm
+MIT

package/src/images/.gitkeep

@@ -0,0 +1,3 @@
+# This file keeps the images directory in git
+# Add your images here - they will be copied to dist/images/
+

package/src/notes/2024-12-17-first-note.md

@@ -0,0 +1,6 @@
+---
+date: 2024-12-17T10:30:00Z
+tags: [thoughts]
+---
+
+Just set up my new blog with Sia! The live reload feature is super handy for writing.

package/src/pages/about.md

@@ -0,0 +1,29 @@
+---
+title: "About"
+layout: page
+---
+
+## About This Site
+
+This site is built with **Sia**, a simple and powerful static site generator.
+
+### About Me
+
+Hello! I'm the author of this blog. Feel free to customize this page with your own information.
+
+### Contact
+
+You can reach me at:
+
+- Email: your.email@example.com
+- Twitter: @yourhandle
+- GitHub: @yourusername
+
+### Colophon
+
+This site is:
+
+- Generated with [Sia](https://github.com/sia/sia)
+- Written in Markdown
+- Styled with CSS
+- Hosted on [your hosting provider]