@terrymooreii/sia 1.0.1 → 2.0.0

package/src/posts/2024-12-16-markdown-features.md

@@ -0,0 +1,76 @@
+---
+title: "Markdown Features Guide"
+date: 2024-12-16
+tags: [markdown, tutorial]
+---
+
+This post demonstrates the markdown features supported by Static Forge.
+
+## Headers
+
+Use `#` for headers. The more `#` symbols, the smaller the header.
+
+## Text Formatting
+
+You can make text **bold**, *italic*, or ***both***. You can also use ~~strikethrough~~.
+
+## Links and Images
+
+[This is a link](https://example.com) and here's how to add images:
+
+```markdown
+![Alt text](/images/photo.jpg)
+```
+
+## Lists
+
+### Unordered Lists
+
+- First item
+- Second item
+  - Nested item
+  - Another nested item
+- Third item
+
+### Ordered Lists
+
+1. First step
+2. Second step
+3. Third step
+
+## Blockquotes
+
+> "The best way to predict the future is to create it."
+> — Peter Drucker
+
+## Code
+
+Inline `code` looks like this.
+
+Code blocks with syntax highlighting:
+
+```javascript
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+
+console.log(greet('World'));
+```
+
+## Tables
+
+| Feature | Supported |
+|---------|-----------|
+| Markdown | ✅ |
+| Front Matter | ✅ |
+| Tags | ✅ |
+| Pagination | ✅ |
+
+## Horizontal Rule
+
+Use `---` for a horizontal rule:
+
+---
+
+That's it! Enjoy writing in markdown.
+

package/src/posts/2024-12-17-welcome-to-sia.md

@@ -0,0 +1,78 @@
+---
+title: "Welcome to Sia"
+date: 2024-12-17
+tags: [getting-started, sia]
+---
+
+Welcome to your new blog powered by **Sia**! This is a sample post to help you get started.
+
+## What is Sia?
+
+Sia is a simple, powerful static site generator that supports:
+
+- **Markdown** with front matter for easy content creation
+- **Nunjucks templates** for flexible layouts
+- **Tags** for organizing your content
+- **Pagination** for listing pages
+- **Live reload** during development
+- **Clean, light theme** out of the box
+
+## Getting Started
+
+### Creating Content
+
+To create a new blog post:
+
+```bash
+npx sia new post "My New Post"
+```
+
+To create a new page:
+
+```bash
+npx sia new page "About Me"
+```
+
+To create a short note (like a tweet):
+
+```bash
+npx sia new note "Just discovered something cool!"
+```
+
+### Running the Development Server
+
+```bash
+npm run dev
+```
+
+This will start a local server with live reload at `http://localhost:3000`.
+
+### Building for Production
+
+```bash
+npm run build
+```
+
+This will generate your static site in the `dist` folder, ready to deploy!
+
+## Front Matter
+
+Each markdown file can have front matter at the top:
+
+```yaml
+---
+title: "My Post Title"
+date: 2024-12-17
+tags: [tag1, tag2]
+draft: true  # Set to true to hide from production
+---
+```
+
+## Customization
+
+- Edit `_config.yml` to change site settings
+- Add custom layouts in `_layouts/`
+- Add custom includes in `_includes/`
+- Override default styles by adding `styles/main.css`
+
+Happy blogging! 🚀

package/src/posts/2024-12-17-welcome-to-static-forge.md

@@ -0,0 +1,78 @@
+---
+title: "Welcome to Sia"
+date: 2024-12-17
+tags: [getting-started, sia]
+---
+
+Welcome to your new blog powered by **Sia**! This is a sample post to help you get started.
+
+## What is Sia?
+
+Sia is a simple, powerful static site generator that supports:
+
+- **Markdown** with front matter for easy content creation
+- **Nunjucks templates** for flexible layouts
+- **Tags** for organizing your content
+- **Pagination** for listing pages
+- **Live reload** during development
+- **Clean, light theme** out of the box
+
+## Getting Started
+
+### Creating Content
+
+To create a new blog post:
+
+```bash
+npx sia new post "My New Post"
+```
+
+To create a new page:
+
+```bash
+npx sia new page "About Me"
+```
+
+To create a short note (like a tweet):
+
+```bash
+npx sia new note "Just discovered something cool!"
+```
+
+### Running the Development Server
+
+```bash
+npm run dev
+```
+
+This will start a local server with live reload at `http://localhost:3000`.
+
+### Building for Production
+
+```bash
+npm run build
+```
+
+This will generate your static site in the `dist` folder, ready to deploy!
+
+## Front Matter
+
+Each markdown file can have front matter at the top:
+
+```yaml
+---
+title: "My Post Title"
+date: 2024-12-17
+tags: [tag1, tag2]
+draft: true  # Set to true to hide from production
+---
+```
+
+## Customization
+
+- Edit `_config.yml` to change site settings
+- Add custom layouts in `_layouts/`
+- Add custom includes in `_includes/`
+- Override default styles by adding `styles/main.css`
+
+Happy blogging! 🚀

package/.github/workflows/main.yml

@@ -1,33 +0,0 @@
-name: Build and GH-Page Deploy
-
-on:
-  push:
-    branches:
-      - main
-
-permissions:
-  contents: write
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v3
-        with:
-          persist-credentials: false
-
-      - name: Install
-        run: npm install
-
-      - name: Build
-        run: |
-          npm run build
-
-      - name: Deploy to GH Page
-        uses: JamesIves/github-pages-deploy-action@4.1.1
-        with:
-          branch: gh-pages
-          folder: public
-          ssh-key: ${{ secrets.DEPLOY_KEY }}

package/.prettierignore

@@ -1,3 +0,0 @@
-# Ignore artifacts:
-public
-node_modules

package/.prettierrc

@@ -1,8 +0,0 @@
-{
-  "printWidth": 120,
-  "tabWidth": 2,
-  "jsxBracketSameLine": true,
-  "singleQuote": true,
-  "semi": false,
-  "trailingComma": "es5"
-}

package/lib/helpers.js

@@ -1,37 +0,0 @@
-import fs from 'fs'
-
-export const formatDate = (postDate) => {
-  const d = new Date(postDate)
-  const date = d.toLocaleDateString('en-us', {
-    year: 'numeric',
-    month: 'long',
-    day: 'numeric',
-  })
-  const time = d.toLocaleTimeString()
-  return {
-    datetime: `${date} ${time}`,
-    date,
-    year: d.getFullYear(),
-  }
-}
-
-export const mkdir = (path) => {
-  if (!fs.existsSync(path)) {
-    fs.mkdirSync(path)
-    return true
-  }
-  return false
-}
-
-export const cpdir = (src, dest) => {
-  if (fs.existsSync(src)) {
-    mkdir(dest)
-    fs.cpSync(src, dest, { recursive: true })
-    return true
-  }
-  return false
-}
-
-export const writefile = (file, content, options = { flags: 'w+' }) => {
-  fs.writeFileSync(file, content, options)
-}

package/lib/markdown.js

@@ -1,33 +0,0 @@
-import config from './readconfig.js'
-import markdownit from 'markdown-it'
-import hljs from 'highlight.js'
-
-import javascript from 'highlight.js/lib/languages/javascript'
-import bash from 'highlight.js/lib/languages/bash'
-hljs.registerLanguage('javascript', javascript)
-hljs.registerLanguage('bash', bash)
-
-const md = markdownit({
-  html: true,
-  linkify: true,
-  typographer: true,
-  breaks: true,
-  highlight: function (str, lang) {
-    if (config?.app?.markdown?.highlightjs && lang && hljs.getLanguage(lang)) {
-      try {
-        return hljs.highlight(str, { language: lang }).value
-      } catch (__) {}
-    }
-
-    return ''
-  },
-  ...config?.app?.markdown?.markdownitOptions,
-})
-
-if (config?.app?.markdown?.plugins) {
-  config.app.markdown.plugins.forEach((plugin) => {
-    md.use(plugin)
-  })
-}
-
-export default md

package/lib/parse.js

@@ -1,94 +0,0 @@
-import config from './readconfig.js'
-import matter from 'gray-matter'
-import fs from 'fs'
-import path from 'path'
-import nunjucks from 'nunjucks'
-import md from './markdown.js'
-
-import { formatDate, mkdir, writefile } from './helpers.js'
-
-const { app, site } = config
-
-nunjucks.configure(path.join(app.src, app.partials), {
-  autoescape: false,
-})
-
-const render = (srcFolder, publicFolder, file) => {
-  const parsed = matter.read(path.join(srcFolder, file))
-  const { data: page, content } = parsed
-  const fileName = path.parse(file).name
-  const fileNameHtml = `${fileName}.html`
-
-  if (!page.template) return
-
-  page.date = formatDate(page.created_at)
-
-  // technically slug is the permalink or uri
-  // this removes the public folder path to reveal the slug path
-  page.slug = path.join(publicFolder).replace(app.public, '')
-  // index pages will render automatically in folder but if the file
-  // name is not then make sure it included in the permalink
-  if (fileNameHtml !== 'index.html') {
-    page.slug = path.join(page.slug, fileNameHtml)
-  }
-
-  const html = md.render(content)
-  const rendered = nunjucks.render(`${page.template}${app.template_ext}`, {
-    content: html,
-    page,
-    site,
-  })
-
-  writefile(path.join(publicFolder, fileNameHtml), rendered)
-
-  // collect all the page attibutes for blog posts
-  if (page.template === 'post') {
-    return { ...page }
-  }
-}
-
-const getAllFiles = (srcPath, posts) => {
-  // take the source path and generate the public path equivalent
-  const publicPath = srcPath.replace(path.join(app.src, app.content), app.public)
-
-  mkdir(publicPath)
-
-  const files = fs.readdirSync(srcPath)
-
-  files.forEach((file) => {
-    const filePath = path.join(srcPath, file)
-
-    if (fs.statSync(filePath).isDirectory()) {
-      // recursively look at files
-      getAllFiles(filePath, posts)
-    } else {
-      // Process markdown files and render the nunjucks template
-      if (path.extname(file) === '.md') {
-        const post = render(srcPath, publicPath, file)
-        if (post) {
-          posts.push(post)
-        }
-      } else {
-        // file is not a markdown file so just copy it to its public folder
-        fs.copyFileSync(path.join(srcPath, file), path.join(publicPath, file))
-      }
-    }
-  })
-  return posts
-}
-
-export const parseContent = () => {
-  return getAllFiles(path.join(app.src, app.content), [], '/').filter((o) => o != null) // make sure there are no undefined items
-}
-
-export const generateBlogListPage = (posts) => {
-  const rendered = nunjucks.render(app.posts_template, {
-    posts,
-    site,
-  })
-
-  const blogListDirectory = path.join(app.public, app.blog_list)
-
-  mkdir(blogListDirectory)
-  writefile(path.join(blogListDirectory, 'index.html'), rendered)
-}

package/lib/readconfig.js

@@ -1,16 +0,0 @@
-import { findUp } from 'find-up'
-
-async function getConfig() {
-  try {
-    const siarc = await findUp('siarc.js')
-    const { default: config } = await import(siarc)
-    return config
-  } catch (err) {
-    console.log('Unable to find and load the siarc.js file.')
-  }
-}
-const config = await getConfig()
-export default config ?? {
-  app: {},
-  site: {},
-}

package/lib/rss.js

@@ -1,63 +0,0 @@
-import fs from 'fs'
-import path from 'path'
-import { Feed } from 'feed'
-import config from './readconfig.js'
-const { app, site } = config
-
-const feed = new Feed({
-  title: site.blog_title,
-  description: site.blog_description,
-  id: site.blog_url,
-  link: site.blog_url,
-  language: 'en', // optional, used only in RSS 2.0, possible values: http://www.w3.org/TR/REC-html40/struct/dirlang.html#langcodes
-  image: site.blog_image,
-  favicon: `${site.blog_url}/assets/favicon.ico`,
-  copyright: `All rights reserved ${new Date().getFullYear()}, ${site.author}`,
-  feedLinks: {
-    json: `${site.blog_url}/feed.json`,
-    atom: `${site.blog_url}/atom.xml`,
-  },
-  author: {
-    name: site.author,
-    email: site.email_address,
-  },
-})
-
-const writeFeed = (name, content) => {
-  fs.writeFileSync(path.join(app.public, name), content, {
-    flag: 'w+',
-  })
-}
-
-export const generateRSS = (posts, count = 10) => {
-  posts.splice(0, count).forEach((post) => {
-    feed.addItem({
-      title: post.title,
-      id: `${site.blog_url}${post.slug}`,
-      link: `${site.blog_url}${post.slug}`,
-      description: post.description,
-      content: post.content,
-      author: [
-        {
-          name: site.author,
-          email: site.email_address,
-          link: site.blog_url,
-        },
-      ],
-      date: post.created_at,
-      image: `${site.blog_url}/${post.image}`,
-    })
-  })
-
-  if (app.feed.rss2) {
-    writeFeed('rss.xml', feed.rss2())
-  }
-
-  if (app.feed.atom1) {
-    writeFeed('atom.xml', feed.atom1())
-  }
-
-  if (app.feed.json1) {
-    writeFeed('feed.json', feed.json1())
-  }
-}

package/templates/siarc-template.js

@@ -1,53 +0,0 @@
-import url from 'url'
-import path from 'path'
-
-const __filename = url.fileURLToPath(import.meta.url)
-const __dirname = path.dirname(__filename)
-
-export default {
-  // User Config
-  site: {
-    blog_url: process.env.BLOG_URL || '',
-    blog_title: '',
-    blog_description: '',
-    blog_image: '',
-    author: '',
-    email_address: '',
-    highlightjs_theme: 'atom-one-dark.min',
-    nav: [
-      {
-        title: 'Home',
-        href: '/',
-      },
-      {
-        title: 'Blog',
-        href: '/blog',
-      },
-    ],
-  },
-
-  // App config
-  app: {
-    public: `${__dirname}/public`,
-    src: `${__dirname}/src`,
-    partials: '_partials',
-    template_ext: '.njk',
-    content: 'content',
-    css: 'css',
-    js: 'js',
-    assets: 'assets',
-    images: 'imgs',
-    posts_template: 'posts.njk',
-    blog_list: 'blog',
-    feed: {
-      count: 10,
-      rss2: true,
-      atom1: true,
-      json1: true,
-    },
-    markdown: {
-      highlightjs: true,
-      plugins: [],
-    },
-  },
-}

package/templates/src/_partials/_footer.njk

@@ -1 +0,0 @@
-<footer>Made with Sia</footer>

package/templates/src/_partials/_head.njk

@@ -1,35 +0,0 @@
-<head>
-  <meta charset="UTF-8" />
-  <meta name="viewport" content="width=device-width, initial-scale=1">
-  <title>{{ page.title if page.title else site.blog_title }}</title>
-  <meta name="author" content="{{ site.author }}" />
-  <meta
-    name="description"
-    content="{{ page.description if page.description else site.blog_description }}"
-  />
-  {% if page.slug %}
-  <meta property="og:url" content="{{site.blog_url}}{{ page.slug }}" />
-  {% else %}
-  <meta property="og:url" content="{{site.blog_url}}" />
-  {% endif %}
-  <meta property="og:title" content="{{ page.title if page.title else site.blog_title }}" />
-  <meta property="og:description" content="{{ page.description if page.description else site.blog_description }}" />
-  <meta property="og:image" content="{{ page.post_image }}" />
-
-  <link type="application/rss+xml" rel="alternate" href="{{ site.blog_url }}/rss.xml" title="{{ site.blog_title }} - RSS Feed" />
-  <link type="application/atom+xml" rel="alternate" href="{{ site.blog_url }}/atom.xml" title="{{ site.blog_title }} - Atom Feed" />
-  <link type="application/feed+json" rel="alternate" href="{{ site.blog_url }}/feed.json" title="{{ site.blog_title }} - JSON Feed" />
-
-  <link rel="icon" type="image/x-icon" href="{{ site.blog_url }}/assest/favicon.ico">
-  <link rel="apple-touch-icon" sizes="180x180" href="{{ site.blog_url }}/assets/apple-touch-icon.png">
-  <link rel="icon" type="image/png" sizes="32x32" href="{{ site.blog_url }}/assets/favicon-32x32.png">
-  <link rel="icon" type="image/png" sizes="16x16" href="{{ site.blog_url }}/assets/favicon-16x16.png">
-  <link rel="manifest" href="{{ site.blog_url }}/assets/site.webmanifest">
-
-  <link rel="stylesheet" type="text/css" href="{{ site.blog_url }}/css/theme.css" />
-  <link rel="stylesheet" type="text/css" href="{{ site.blog_url }}/css/markdown.css" />
-  <link
-    rel="stylesheet"
-    href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/{{ site.highlightjs_theme }}.css"
-  />
-</head>

package/templates/src/_partials/_header.njk

@@ -1 +0,0 @@
-<!-- add content here to add it to the top of each page/post -->

package/templates/src/_partials/_layout.njk

@@ -1,12 +0,0 @@
-<!DOCTYPE >
-<html lang="en-US">
-  {% include "_head.njk" %}
-  <body class="markdown-body" data-theme="dark">
-    {% include "_nav.njk" %}
-    <main class="content">
-      {% include "_header.njk" %}
-      {% block content %}{% endblock %} 
-      {% include "_footer.njk" %}
-    </main>
-  </body>
-</html>

package/templates/src/_partials/_nav.njk

@@ -1,12 +0,0 @@
-<nav>
-  <div class="content nav-container">
-    <h1 class="blog-title"><a href="{{ site.blog_url }}">{{ site.blog_title }}</a></h1>
-    <ul>
-      {% for link in site.nav %}
-      <li>
-        <a href="{{ site.blog_url }}{{ link.href }}" title="{{ link.title }}">{{ link.title }}</a>
-      </li>
-      {% endfor %}
-    </ul>
-  </div>
-</nav>

package/templates/src/_partials/page.njk

@@ -1,5 +0,0 @@
-{%extends "_layout.njk" %} 
-
-{% block content %} 
-{{ content }}
-{% endblock %}

package/templates/src/_partials/post.njk

@@ -1,13 +0,0 @@
-{%extends "_layout.njk" %} 
-
-{% block content %}
-<article>
-  <header>
-    <h1 class="post-title">{{ page.title }}</h1>
-    <time datetime="{{page.date.datetime}}" class="date">
-      {{ page.date.datetime }}
-    </time>
-  </header>
-  <p>{{ content }}</p>
-</article>
-{% endblock %}

package/templates/src/_partials/posts.njk

@@ -1,19 +0,0 @@
-{%extends "_layout.njk" %}
-
-{% block content %}
-<div class="posts">
-  {% for year, posts in posts | sort(true, false, 'created_at') | groupby("date.year") %}
-  <div class="year">{{ year }}</div>
-  <ul>
-    {% for post in posts %}
-    <li>
-      <span class="date" title="{{ post.datetime}}">
-        {{ post.date.date }}
-      </span>
-      <a href="{{ site.blog_url }}{{ post.slug }}" title="{{ post.title }}"> {{ post.title }} </a>
-    </li>
-    {% endfor %}
-  </ul>
-  {% endfor %}
-</div>
-{% endblock %}