@terrymooreii/sia 2.1.6 → 2.1.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@terrymooreii/sia",
-  "version": "2.1.6",
+  "version": "2.1.8",
   "description": "A simple, powerful static site generator with markdown, front matter, and Nunjucks templates",
   "main": "lib/index.js",
   "bin": {

package/readme.md

@@ -1,3 +1,7 @@
+
+
+![Sia](./docs/imgs/logo-sia-t.png)
+
 # Sia
 
 A simple, powerful static site generator built with JavaScript. Similar to Eleventy/11ty, Sia supports markdown, front matter, Nunjucks templates, and more.
@@ -11,8 +15,10 @@ A simple, powerful static site generator built with JavaScript. Similar to Eleve
 - **Tags & Categories** - Organize content with tags, auto-generated tag pages
 - **Pagination** - Built-in pagination for listing pages
 - **Image Support** - Automatic image copying and organization
+- **Static Assets** - Support for favicons, fonts, and other static files
 - **Live Reload** - Development server with hot reloading
-- **Themes** - Built-in themes (main, minimal) with light/dark mode toggle
+- **Themes** - Built-in themes (main, minimal, developer, magazine) with light/dark mode toggle
+- **Custom Themes** - Create and share themes as npm packages (`sia-theme-*`)
 - **RSS Feed** - Automatic RSS feed generation
 - **YAML/JSON Config** - Flexible configuration options
 
@@ -88,6 +94,10 @@ my-site/
 │   ├── pages/           # Static pages
 │   ├── notes/           # Short notes/tweets
 │   └── images/          # Images
+├── assets/              # Static assets (optional)
+├── static/              # Static assets (optional)
+├── public/              # Static assets (optional)
+├── favicon.ico          # Site favicon (optional)
 ├── _layouts/            # Custom layouts (optional)
 ├── _includes/           # Custom includes (optional)
 ├── styles/              # Custom CSS (optional)
@@ -144,6 +154,58 @@ server:
 
 When `showDrafts` is set to `true`, draft posts (posts with `draft: true` in front matter) will be included in the development server build. This is useful for previewing draft content locally. Drafts are always excluded from production builds.
 
+## Static Assets
+
+Sia automatically copies static assets during the build process. You can place static files in any of these locations:
+
+- **`assets/`** - Place files in `assets/` at the project root
+- **`static/`** - Place files in `static/` at the project root
+- **`public/`** - Place files in `public/` at the project root
+- **Root directory** - Place `favicon.ico` directly in the project root
+
+All files from these directories will be copied to the `dist/` folder during build, preserving their directory structure.
+
+### Supported File Types
+
+Static assets include:
+- **Favicons** - `.ico` files (favicon.ico can be in root or asset directories)
+- **Fonts** - `.woff`, `.woff2`, `.ttf`, `.eot`
+- **Documents** - `.pdf`, `.txt`, `.json`, `.xml`
+- **Scripts** - `.js` files
+- **Stylesheets** - `.css` files (though custom CSS is better placed in `styles/`)
+- **Images** - All image formats (though images are better placed in `src/images/`)
+
+### Example Structure
+
+```
+my-site/
+├── assets/
+│   ├── favicon.ico
+│   ├── robots.txt
+│   ├── manifest.json
+│   └── fonts/
+│       └── custom-font.woff2
+├── static/
+│   └── documents/
+│       └── resume.pdf
+└── favicon.ico  # Also supported in root
+```
+
+During build, these will be copied to:
+```
+dist/
+├── assets/
+│   ├── favicon.ico
+│   ├── robots.txt
+│   ├── manifest.json
+│   └── fonts/
+│       └── custom-font.woff2
+├── static/
+│   └── documents/
+│       └── resume.pdf
+└── favicon.ico
+```
+
 ## Front Matter
 
 Each markdown file can have YAML front matter:
@@ -391,8 +453,55 @@ sia build --clean
 sia new post "Title"
 sia new page "Title"
 sia new note "Content"
+
+# Create a new theme package
+sia theme my-theme
+sia theme my-theme --quick  # Skip prompts
+```
+
+## Custom Theme Packages
+
+Sia supports external themes distributed as npm packages. Theme packages must be named `sia-theme-{name}`.
+
+### Using an External Theme
+
+```bash
+# Install the theme package
+npm install sia-theme-awesome
+
+# Configure in _config.yml
+```
+
+```yaml
+theme:
+  name: awesome  # Uses sia-theme-awesome package
+```
+
+Sia resolves themes in this order:
+1. Built-in themes (`main`, `minimal`, `developer`, `magazine`)
+2. npm packages matching `sia-theme-{name}`
+
+### Creating a Theme Package
+
+```bash
+# Generate a new theme scaffold
+sia theme my-theme
+
+# This creates sia-theme-my-theme/ with:
+# - package.json (properly configured)
+# - README.md (documentation template)
+# - layouts/, includes/, pages/, styles/
 ```
 
+After customizing, publish to npm:
+
+```bash
+cd sia-theme-my-theme
+npm publish
+```
+
+See [Creating Themes](docs/creating-themes.md) for detailed documentation.
+
 ## Upgrading
 
 If you installed Sia as a dependency (recommended):

package/themes/developer/pages/blog.njk

@@ -23,7 +23,7 @@
           <a href="{{ post.url }}">{{ post.title }}</a>
         </h2>
         
-        <p class="card-excerpt">{{ post.excerpt | excerpt(150) }}</p>
+        <p class="card-excerpt">{{ post.excerptHtml | safe }}</p>
         
         <div class="card-meta">
           <span class="card-date">{{ post.date | date('short') }}</span>

package/themes/developer/pages/feed.njk

@@ -12,7 +12,7 @@
       <link>{{ site.url }}{{ post.url }}</link>
       <guid isPermaLink="true">{{ site.url }}{{ post.url }}</guid>
       <pubDate>{{ post.date | date('rss') }}</pubDate>
-      <description><![CDATA[{{ post.excerpt | excerpt(300) }}]]></description>
+      <description><![CDATA[{{ post.excerptHtml | safe }}]]></description>
       {% for tag in post.tags %}
       <category>{{ tag }}</category>
       {% endfor %}

package/themes/developer/pages/index.njk

@@ -51,7 +51,7 @@
       {% for note in collections.notes | limit(3) %}
       <article class="note-card">
         <time class="note-time">{{ note.date | date('short') }}</time>
-        <div class="note-preview">{{ note.excerpt | excerpt(150) }}</div>
+        <div class="note-preview">{{ note.excerptHtml | safe  }}</div>
         <a href="{{ note.url }}" class="note-link">Read more →</a>
       </article>
       {% endfor %}

package/themes/developer/pages/notes.njk

@@ -16,7 +16,7 @@
           {{ note.date | date('full') }}
         </time>
         <div class="timeline-body">
-          <div class="note-text">{{ note.excerpt | excerpt(200) }}</div>
+          <div class="note-text">{{ note.excerptHtml | safe }}</div>
           <a href="{{ note.url }}" class="read-more">Continue reading →</a>
         </div>
         {% if note.tags %}

package/themes/magazine/layouts/post.njk

@@ -12,8 +12,8 @@
     
     <h1 class="article-title">{{ page.title }}</h1>
     
-    {% if page.excerpt %}
-    <p class="article-subtitle">{{ page.excerpt | excerpt(200) }}</p>
+    {% if page.excerptHtml | safe %}
+    <p class="article-subtitle">{{ page.excerptHtml | safe }}</p>
     {% endif %}
     
     <div class="article-byline">

package/themes/magazine/pages/blog.njk

@@ -16,7 +16,7 @@
       <h2 class="row-title">
         <a href="{{ post.url }}">{{ post.title }}</a>
       </h2>
-      <p class="row-excerpt">{{ post.excerpt | excerpt(180) }}</p>
+      <p class="row-excerpt">{{ post.excerptHtml | safe }}</p>
       <div class="row-meta">
         <span class="row-author">{{ post.author or site.author }}</span>
         <span class="meta-separator">·</span>

package/themes/magazine/pages/index.njk

@@ -14,7 +14,7 @@
       <h2 class="featured-title">
         <a href="{{ featuredPost.url | url }}">{{ featuredPost.title }}</a>
       </h2>
-      <p class="featured-excerpt">{{ featuredPost.excerpt | excerpt(200) }}</p>
+      <p class="featured-excerpt">{{ featuredPost.excerptHtml | safe }}</p>
       <div class="featured-meta">
         <span class="featured-author">{{ featuredPost.author or site.author }}</span>
         <span class="featured-date">{{ featuredPost.date | date('long') }}</span>
@@ -41,7 +41,7 @@
         <h3 class="card-title">
           <a href="{{ post.url | url }}">{{ post.title }}</a>
         </h3>
-        <p class="card-excerpt">{{ post.excerpt | excerpt(100) }}</p>
+        <p class="card-excerpt">{{ post.excerptHtml | safe }}</p>
         <div class="card-meta">
           <time datetime="{{ post.date | date('iso') }}">{{ post.date | date('short') }}</time>
           <span>·</span>
@@ -64,7 +64,7 @@
     {% for note in collections.notes | limit(3) %}
     <article class="note-preview">
       <time datetime="{{ note.date | date('iso') }}">{{ note.date | date('short') }}</time>
-      <p>{{ note.excerpt | excerpt(150) }}</p>
+      <p>{{ note.excerptHtml | safe }}</p>
       <a href="{{ note.url | url }}" class="note-link">Read note →</a>
     </article>
     {% endfor %}

package/themes/magazine/pages/notes.njk

@@ -13,7 +13,7 @@
       {{ note.date | date('full') }}
     </time>
     <div class="note-content">
-      <p>{{ note.excerpt | excerpt(250) }}</p>
+      <p>{{ note.excerptHtml | safe }}</p>
       <a href="{{ note.url }}" class="note-read-more">Continue reading →</a>
     </div>
     {% if note.tags %}

package/themes/main/includes/footer.njk

@@ -2,7 +2,7 @@
   <div class="container">
     <p class="footer-text">
       © {{ "now" | date('year') }} {{ site.author or site.title }}. 
-      Built with <a href="https://github.com/sia/sia">Sia</a>.
+      Built with <a href="https://github.com/terrymooreii/sia">Sia</a>.
     </p>
     
     <nav class="footer-nav">

package/themes/main/pages/blog.njk

@@ -24,7 +24,7 @@
       {% endfor %}
     </div>
     {% endif %}
-    <p class="post-card-excerpt">{{ post.excerpt }}</p>
+    <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     <a href="{{ post.url }}" class="post-card-link">Read more →</a>
   </article>
   {% else %}

package/themes/main/pages/index.njk

@@ -26,7 +26,7 @@
         </span>
         {% endif %}
       </div>
-      <p class="post-card-excerpt">{{ post.excerpt }}</p>
+      <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     </article>
   {% else %}
   <p class="empty-message">No posts yet. Create your first post with <code>npx sia new post "My First Post"</code></p>
@@ -44,7 +44,7 @@
   <div class="notes-grid">
     {% for note in collections.notes | limit(3) %}
     <article class="note-card">
-      <div class="note-card-content">{{ note.excerpt }}</div>
+      <div class="note-card-content">{{ note.excerptHtml | safe  }}</div>
       <footer class="note-card-footer">
         <time datetime="{{ note.date | date('iso') }}">{{ note.date | date('full_time') }}</time>
         <a href="{{ note.url }}" class="note-card-link">View →</a>

package/themes/main/pages/tag.njk

@@ -10,7 +10,7 @@
   {% for post in posts %}
   <article class="post-card">
     <h2 class="post-card-title">
-      <a href="{{ post.url }}">{{ post.title or post.excerpt }}</a>
+      <a href="{{ post.url }}">{{ post.title or post.excerptHtml | safe }}</a>
       {% if post.draft %}<span class="draft-badge">Draft</span>{% endif %}
     </h2>
     <div class="post-card-meta">
@@ -26,8 +26,8 @@
       {% endfor %}
     </div>
     {% endif %}
-    {% if post.excerpt %}
-    <p class="post-card-excerpt">{{ post.excerpt }}</p>
+    {% if post.excerptHtml %}
+    <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     {% endif %}
   </article>
   {% endfor %}

package/themes/minimal/includes/footer.njk

@@ -2,7 +2,7 @@
   <div class="container">
     <p class="footer-text">
       © {{ "now" | date('year') }} {{ site.author or site.title }}. 
-      Built with <a href="https://github.com/sia/sia">Sia</a>.
+      Built with <a href="https://github.com/terrymooreii/sia">Sia</a>.
     </p>
     
     <nav class="footer-nav">

package/themes/minimal/pages/blog.njk

@@ -24,7 +24,7 @@
       {% endfor %}
     </div>
     {% endif %}
-    <p class="post-card-excerpt">{{ post.excerpt }}</p>
+    <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     <a href="{{ post.url }}" class="post-card-link">Read more →</a>
   </article>
   {% else %}

package/themes/minimal/pages/index.njk

@@ -26,7 +26,7 @@
         </span>
         {% endif %}
       </div>
-      <p class="post-card-excerpt">{{ post.excerpt }}</p>
+      <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     </article>
   {% else %}
   <p class="empty-message">No posts yet. Create your first post with <code>npx sia new post "My First Post"</code></p>

package/themes/minimal/pages/tag.njk

@@ -10,7 +10,7 @@
   {% for post in posts %}
   <article class="post-card">
     <h2 class="post-card-title">
-      <a href="{{ post.url }}">{{ post.title or post.excerpt }}</a>
+      <a href="{{ post.url }}">{{ post.title or post.excerptHtml | safe }}</a>
       {% if post.draft %}<span class="draft-badge">Draft</span>{% endif %}
     </h2>
     <div class="post-card-meta">
@@ -26,8 +26,8 @@
       {% endfor %}
     </div>
     {% endif %}
-    {% if post.excerpt %}
-    <p class="post-card-excerpt">{{ post.excerpt }}</p>
+    {% if post.excerptHtml %}
+    <p class="post-card-excerpt">{{ post.excerptHtml | safe }}</p>
     {% endif %}
   </article>
   {% endfor %}

package/themes/minimal/pages/tags.njk

@@ -20,7 +20,7 @@
       <ul class="tag-posts">
         {% for item in tag.items | limit(5) %}
         <li>
-          <a href="{{ item.url }}">{{ item.title or item.excerpt }}</a>
+          <a href="{{ item.url }}">{{ item.title or item.excerptHtml | safe }}</a>
           <time datetime="{{ item.date | date('iso') }}">{{ item.date | date('short') }}</time>
         </li>
         {% endfor %}