fossbook 0.0.6 → 0.0.8

package/README.md

@@ -1,6 +1,7 @@
 # Fossbook
 
 A lightweight static blog site generator for GitHub Pages, similar to Hugo but built with Node.js.
+It was originally part of the [F/OSS Comics blog](https://fosscomics.com) and is now an independent, installable package that anyone can use.
 
 ## Features
 
@@ -85,6 +86,18 @@ module.exports = {
   image: "https://example.com/default-image.png",
   theme: "archie",
 
+  // Optional: URL prefix for posts. Defaults to "posts" -> /posts/<slug>/.
+  // Set to "" to serve posts at the site root, /<slug>/.
+  postsPath: "posts",
+
+  // Optional comments (see "Comments" below)
+  comments: {
+    provider: "utterances",
+    repo: "you/your-blog",
+    issueTerm: "pathname",
+    theme: "github-light",
+  },
+
   // Directory overrides (defaults shown)
   content: "./content",
   postsDir: "./content/posts",
@@ -119,6 +132,21 @@ content/posts/My Post Title/
     └── feature.png
 ```
 
+### Post URLs
+
+By default, posts are served under `/posts/`, e.g. `/posts/my-post-title/`. To
+change the prefix or move posts to the site root, set `postsPath` in
+`fossbook.config.js`:
+
+```js
+postsPath: "",          // serves the post above at /my-post-title/ (site root)
+// postsPath: "blog",   // or use a different prefix: /blog/my-post-title/
+```
+
+This affects the generated output directory, the post URL, post links on the
+home/all-posts/tag pages, and image paths. The on-disk source layout under
+`content/posts/` does not change.
+
 ## CLI Reference
 
 ```
@@ -148,6 +176,46 @@ Fossbook ships with the Archie theme by default. To use a custom theme:
 
 Theme resolution order: user project `themes/` → built-in `themes/`.
 
+## Comments
+
+Fossbook supports [utterances](https://utteranc.es) — a commenting widget that
+stores comments as GitHub issues. When enabled, a comment box is rendered at the
+bottom of every post page.
+
+### Setup
+
+1. Make the repository that backs the comments **public**.
+2. Install the [utterances GitHub App](https://github.com/apps/utterances) on
+   that repository so the bot can create issues.
+3. Add a `comments` block to `fossbook.config.js`:
+
+```js
+comments: {
+  provider: "utterances",        // currently the only supported provider
+  repo: "you/your-blog",         // owner/repo that stores the comment issues
+  issueTerm: "pathname",         // how a post maps to an issue (see below)
+  theme: "github-light",         // any utterances theme, e.g. "github-dark"
+},
+```
+
+Omit the `comments` block (or set it to `null`) to disable comments.
+
+### Options
+
+| Field       | Required | Default          | Description                                                      |
+| ----------- | -------- | ---------------- | ---------------------------------------------------------------- |
+| `provider`  | yes      | —                | Must be `"utterances"`.                                          |
+| `repo`      | yes      | —                | `owner/repo` whose issues store the comments.                    |
+| `issueTerm` | no       | `"pathname"`     | Mapping between a page and its issue: `pathname`, `url`, `title`, `og:title`. |
+| `theme`     | no       | `"github-light"` | Any [utterances theme](https://utteranc.es/#configuration).      |
+
+### Mapping notes
+
+With `issueTerm: "pathname"`, each post is matched to a GitHub issue whose title
+equals the page's pathname (with the leading slash stripped). If you change a
+post's URL, the existing comment thread no longer matches — rename the issue
+title to the new pathname to keep the old comments.
+
 ### Required layout files
 
 ```

package/lib/deploy.js

@@ -44,6 +44,7 @@ async function deploy(config, options = {}) {
       }).trim();
       if (!unpushed) {
         console.log("No changes to commit and no unpushed commits.");
+        printSiteUrl(config);
         return;
       }
       console.log("No new changes to commit, but found unpushed commits. Pushing...");
@@ -156,6 +157,7 @@ async function waitForDeployment(cwd, config) {
     if (runs.length === 0) {
       console.log("No workflow runs found. The deployment may not be configured yet.");
       console.log("Enable GitHub Pages: Settings → Pages → Source → GitHub Actions");
+      printSiteUrl(config);
       return;
     }
 

package/lib/init.js

@@ -41,6 +41,8 @@ jobs:
 
       - name: Setup Pages
         uses: actions/configure-pages@v4
+        with:
+          enablement: true
 
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v3

package/lib/mod/config.js

@@ -17,6 +17,7 @@ const defaults = {
   image: "",
   theme: "archie",
   basePath: "",  // auto-detected for GitHub Pages project sites, e.g. "/repo-name/"
+  postsPath: "posts",  // URL prefix for posts: "posts" serves articles at /posts/<slug>/; set "" for root
   comments: null,  // { provider: "utterances", repo: "user/repo", issueTerm: "pathname", theme: "github-light" }
   content: "./content",
   postsDir: "./content/posts",
@@ -91,6 +92,9 @@ function loadConfig(configPath) {
     merged.basePath += "/";
   }
 
+  // Normalize postsPath into a bare segment without surrounding slashes
+  merged.postsPath = (merged.postsPath || "").replace(/^\/+|\/+$/g, "");
+
   return merged;
 }
 

package/lib/mod/page.js

@@ -26,6 +26,9 @@ module.exports = class Page extends PageBase {
       // If there's no .md extension, just get the last part of the path
       this.path = path.basename(filePath);
     }
+    // The source folder name, used to locate the post's images on disk.
+    // this.path may later be prefixed (e.g. "posts/<slug>") for output/URLs.
+    this.slug = this.path;
     // parsed content by fields and body
     const content = fm(mdContent);
 
@@ -75,7 +78,7 @@ module.exports = class Page extends PageBase {
           recursive: true,
         });
 
-      fs.mkdirSync(outPath);
+      fs.mkdirSync(outPath, { recursive: true });
     } else {
       // remove the outputPath file if it exists
       const outPath = path.join(this.config.dev.outdir, this.path);
@@ -96,7 +99,7 @@ module.exports = class Page extends PageBase {
     );
 
     // if there is the images folder in the output directory.
-    const srcImagesDir = path.join(this.config.dev.postsdir, this.path, "images");
+    const srcImagesDir = path.join(this.config.dev.postsdir, this.slug, "images");
     if (
       fs.existsSync(srcImagesDir) &&
       this.path !== ""
@@ -104,7 +107,7 @@ module.exports = class Page extends PageBase {
       // Copy images folder from postsdir to outdir
       const destImagesDir = path.join(this.config.dev.outdir, this.path, "images");
       if (!fs.existsSync(destImagesDir))
-        fs.mkdirSync(destImagesDir);
+        fs.mkdirSync(destImagesDir, { recursive: true });
 
       fs.readdirSync(srcImagesDir).forEach(
         (image) => {

package/lib/posts.js

@@ -23,6 +23,10 @@ module.exports = class Posts {
       }
       const post = new Page(this.config);
       post.readSource(path.join(this.config.dev.postsdir, postPath));
+      // Optionally nest posts under a URL prefix (e.g. "posts" -> /posts/<slug>/).
+      // post.slug stays the source folder name so image lookups remain correct.
+      const prefix = this.config.postsPath ? `${this.config.postsPath}/` : "";
+      post.path = `${prefix}${post.slug}`;
       post.url = `${this.config.blogsite}/${post.path}/`;
       post.imageURL = `${this.config.blogsite}/${post.path}/images/${post.image}`;
       this.posts.push(post);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fossbook",
-  "version": "0.0.6",
+  "version": "0.0.8",
   "description": "A lightweight static blog site generator for GitHub Pages",
   "main": "lib/index.js",
   "scripts": {