fossbook 0.0.4 → 0.0.6

package/lib/mod/page.js

@@ -1,115 +1,119 @@
-const fm = require("front-matter");
-const fs = require("fs");
-const path = require("path");
-const marked = require("./marked");
-const PageBase = require("./page_base");
-
-module.exports = class Page extends PageBase {
-  constructor(config) {
-    super(config);
-    this.srcFilePath = "";
-    this.markdownFilePath = ""; // markdown file path
-    this.contentPath = config.dev.content;
-  }
-
-  readSource(filePath) {
-    if (filePath.indexOf(".md") === -1)
-      this.srcFilePath = filePath + "/index.md";
-    else this.srcFilePath = filePath;
-
-    const mdContent = fs.readFileSync(this.srcFilePath, "utf8");
-
-    if (path.extname(filePath) === ".md") {
-      // If the file has a .md extension, extract the file name without the extension
-      this.path = path.basename(filePath, ".md");
-    } else {
-      // If there's no .md extension, just get the last part of the path
-      this.path = path.basename(filePath);
-    }
-    // parsed content by fields and body
-    const content = fm(mdContent);
-
-    this.title = `${content.attributes.title}`;
-    this.date = content.attributes.date;
-    this.url = `${this.config.blogsite}/${this.path}/`;
-    this.image = content.attributes.image;
-    this.description = content.attributes.description;
-    // default image if no imageURL is specified
-    this.imageURL = this.config.image;
-
-    if (content.attributes.tags && content.attributes.tags.length > 0) {
-      const tagArray = content.attributes.tags.split(",");
-      this.tags = tagArray
-        .map((tag) => tag.trim())
-        .sort((a, b) => a.localeCompare(b));
-    }
-
-    // generated HTML from markdown
-    this.body = marked.parse(content.body);
-    // remove <p></p> and <p> </p> from the beginning and end of the content.body
-    this.body = this.body.replace(/<p><\/p>/g, "").replace(/<p> <\/p>/g, "");
-
-    // for generating the navigation link in the post.html template
-    this.next = null;
-    this.previous = null;
-  }
-
-  // about/index.html or about/hello.html
-  generateContent(templateFile, outputPath) {
-    // For a series of posts
-    if (outputPath === undefined) outputPath = `${this.path}/index.html`;
-    // if file name is not included in the path
-    if (outputPath.indexOf(".htm") === -1) {
-      if (outputPath[outputPath.length - 1] !== "/") outputPath += "/";
-      outputPath += "index.html";
-    }
-
-    // if a directory path is included in the path
-    if (outputPath.indexOf("/") !== -1) {
-      if (this.path === "")
-        this.path = outputPath.split("/").slice(0, -1).join("/");
-
-      if (fs.existsSync(`${this.config.dev.outdir}/${this.path}`))
-        fs.rmSync(`${this.config.dev.outdir}/${this.path}`, {
-          recursive: true,
-        });
-
-      fs.mkdirSync(`${this.config.dev.outdir}/${this.path}`);
-    } else {
-      // remove the outputPath file if it exists
-      if (fs.existsSync(`${this.config.dev.outdir}/${this.path}`))
-        fs.unlinkSync(`${this.config.dev.outdir}/${this.path}`);
-    }
-
-    const layoutsPath = path.join(this.config.themePath, "layouts", templateFile);
-    const postHTML = this.generateHTML(layoutsPath);
-
-    fs.writeFileSync(
-      `${this.config.dev.outdir}/${outputPath}`,
-      postHTML,
-      (e) => {
-        if (e) throw e;
-        console.log(`${outputPath}/index.html was created successfully`);
-      },
-    );
-
-    // if there is the images folder in the output directory.
-    if (
-      fs.existsSync(`${this.config.dev.postsdir}/${this.path}/images`) &&
-      this.path !== ""
-    ) {
-      // Copy images folder from postsdir to outdir
-      if (!fs.existsSync(`${this.config.dev.outdir}/${this.path}/images`))
-        fs.mkdirSync(`${this.config.dev.outdir}/${this.path}/images`);
-
-      fs.readdirSync(`${this.config.dev.postsdir}/${this.path}/images`).forEach(
-        (image) => {
-          fs.copyFileSync(
-            `${this.config.dev.postsdir}/${this.path}/images/${image}`,
-            `${this.config.dev.outdir}/${this.path}/images/${image}`,
-          );
-        },
-      );
-    }
-  }
-};
+const fm = require("front-matter");
+const fs = require("fs");
+const path = require("path");
+const marked = require("./marked");
+const PageBase = require("./page_base");
+
+module.exports = class Page extends PageBase {
+  constructor(config) {
+    super(config);
+    this.srcFilePath = "";
+    this.markdownFilePath = ""; // markdown file path
+    this.contentPath = config.dev.content;
+  }
+
+  readSource(filePath) {
+    if (filePath.indexOf(".md") === -1)
+      this.srcFilePath = filePath + "/index.md";
+    else this.srcFilePath = filePath;
+
+    const mdContent = fs.readFileSync(this.srcFilePath, "utf8");
+
+    if (path.extname(filePath) === ".md") {
+      // If the file has a .md extension, extract the file name without the extension
+      this.path = path.basename(filePath, ".md");
+    } else {
+      // If there's no .md extension, just get the last part of the path
+      this.path = path.basename(filePath);
+    }
+    // parsed content by fields and body
+    const content = fm(mdContent);
+
+    this.title = `${content.attributes.title}`;
+    this.date = content.attributes.date;
+    this.url = `${this.config.blogsite}/${this.path}/`;
+    this.image = content.attributes.image;
+    this.description = content.attributes.description;
+    // default image if no imageURL is specified
+    this.imageURL = this.config.image;
+
+    if (content.attributes.tags && content.attributes.tags.length > 0) {
+      const tagArray = content.attributes.tags.split(",");
+      this.tags = tagArray
+        .map((tag) => tag.trim())
+        .sort((a, b) => a.localeCompare(b));
+    }
+
+    // generated HTML from markdown
+    this.body = marked.parse(content.body);
+    // remove <p></p> and <p> </p> from the beginning and end of the content.body
+    this.body = this.body.replace(/<p><\/p>/g, "").replace(/<p> <\/p>/g, "");
+
+    // for generating the navigation link in the post.html template
+    this.next = null;
+    this.previous = null;
+  }
+
+  // about/index.html or about/hello.html
+  generateContent(templateFile, outputPath) {
+    // For a series of posts
+    if (outputPath === undefined) outputPath = path.join(this.path, "index.html");
+    // if file name is not included in the path
+    if (outputPath.indexOf(".htm") === -1) {
+      outputPath = path.join(outputPath, "index.html");
+    }
+
+    const outputDir = path.dirname(outputPath);
+    // if a directory path is included in the path
+    if (outputDir !== ".") {
+      if (this.path === "")
+        this.path = outputDir;
+
+      const outPath = path.join(this.config.dev.outdir, this.path);
+      if (fs.existsSync(outPath))
+        fs.rmSync(outPath, {
+          recursive: true,
+        });
+
+      fs.mkdirSync(outPath);
+    } else {
+      // remove the outputPath file if it exists
+      const outPath = path.join(this.config.dev.outdir, this.path);
+      if (fs.existsSync(outPath))
+        fs.unlinkSync(outPath);
+    }
+
+    const layoutsPath = path.join(this.config.themePath, "layouts", templateFile);
+    const postHTML = this.generateHTML(layoutsPath);
+
+    fs.writeFileSync(
+      path.join(this.config.dev.outdir, outputPath),
+      postHTML,
+      (e) => {
+        if (e) throw e;
+        console.log(`${outputPath}/index.html was created successfully`);
+      },
+    );
+
+    // if there is the images folder in the output directory.
+    const srcImagesDir = path.join(this.config.dev.postsdir, this.path, "images");
+    if (
+      fs.existsSync(srcImagesDir) &&
+      this.path !== ""
+    ) {
+      // 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.readdirSync(srcImagesDir).forEach(
+        (image) => {
+          fs.copyFileSync(
+            path.join(srcImagesDir, image),
+            path.join(destImagesDir, image),
+          );
+        },
+      );
+    }
+  }
+};

package/lib/mod/page_base.js

@@ -1,97 +1,97 @@
-const fs = require("fs");
-const path = require("path");
-
-module.exports = class PageBase {
-  constructor(config) {
-    this.config = config;
-    this.title = "";
-    this.image = this.config.image;
-    this.description = this.config.blogDescription;
-    this.date = "";
-    this.tags = [];
-    this.content = "";
-    this.url = "";
-    this.theme = this.config.theme;
-  }
-
-  formatDate(date) {
-    const options = { year: "numeric", month: "short", day: "numeric" };
-    return date.toLocaleDateString("en-US", options);
-  }
-
-  googleAnalytics(trackingId) {
-    return `<script async src="https://www.googletagmanager.com/gtag/js?id=${trackingId}"></script>
-        <script>
-          window.dataLayer = window.dataLayer || [];
-          function gtag() {
-            dataLayer.push(arguments);
-          }
-          gtag("js", new Date());
-          gtag("config", "${trackingId}");
-        </script>`;
-  }
-
-  // https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards
-  twitterCard(card) {
-    return `<meta name="twitter:card" content="${card}" />
-        <meta name="twitter:site" content="${this.config.siteTwitter}" />
-        <meta name="twitter:creator" content="${this.config.authorTwitter}" />
-        <meta name="twitter:title" content="${this.title}" />
-        <meta name="twitter:description" content="${this.description}" />
-        <meta name="twitter:image" content="${this.imageURL}" />`;
-  }
-
-  // https://ogp.me/
-  openGraph(type, articleObj) {
-    const result = `<meta property="og:type" content="${type}" />
-        <meta property="og:site_name" content="${this.config.blogName}" />
-        <meta property="og:url" content="${this.url}" />
-        <meta property="og:title" content="${this.title}" />
-        <meta property="og:description" content="${this.description}" />
-        <meta property="og:image" content="${this.imageURL}" />`;
-
-    if (type === "article" && articleObj) {
-      return (
-        result +
-        `
-        <meta property="article:author" content="${articleObj.authorName}" />
-        <meta property="article:published_time" content="${articleObj.publishedDate}" />
-        ${articleObj.tags.map((tag) => `<meta property="article:tag" content="${tag}">`).join("\n        ")}`
-      );
-    }
-    return result;
-  }
-
-  footer() {
-    const footerPath = path.join(this.config.themePath, "layouts", "partials", "footer.html");
-    const footerTemplate = fs.readFileSync(footerPath, "utf-8");
-
-    const funcFooter = new Function(
-      "config",
-      `return () => \`${footerTemplate}\`;`,
-    );
-    const result = funcFooter(this.config)();
-    const footerHTML = result
-      .split("\n")
-      .map((line, index) => (index !== 0 ? `              ${line}` : line))
-      .join("\n");
-
-    return footerHTML;
-  }
-
-  generateHTML(templatePath, data) {
-    const postTemplate = fs.readFileSync(templatePath, "utf-8");
-
-    const funcPost = new Function(
-      "page, data",
-      `return () => \`${postTemplate}\`;`,
-    );
-    const result = funcPost(this, data)();
-    const postHTML = result
-      .split("\n")
-      .map((line, index) => (index !== 0 ? `${line}` : line))
-      .join("\n");
-
-    return postHTML;
-  }
-};
+const fs = require("fs");
+const path = require("path");
+
+module.exports = class PageBase {
+  constructor(config) {
+    this.config = config;
+    this.title = "";
+    this.image = this.config.image;
+    this.description = this.config.blogDescription;
+    this.date = "";
+    this.tags = [];
+    this.content = "";
+    this.url = "";
+    this.theme = this.config.theme;
+  }
+
+  formatDate(date) {
+    const options = { year: "numeric", month: "short", day: "numeric" };
+    return date.toLocaleDateString("en-US", options);
+  }
+
+  googleAnalytics(trackingId) {
+    return `<script async src="https://www.googletagmanager.com/gtag/js?id=${trackingId}"></script>
+        <script>
+          window.dataLayer = window.dataLayer || [];
+          function gtag() {
+            dataLayer.push(arguments);
+          }
+          gtag("js", new Date());
+          gtag("config", "${trackingId}");
+        </script>`;
+  }
+
+  // https://developer.twitter.com/en/docs/twitter-for-websites/cards/overview/abouts-cards
+  twitterCard(card) {
+    return `<meta name="twitter:card" content="${card}" />
+        <meta name="twitter:site" content="${this.config.siteTwitter}" />
+        <meta name="twitter:creator" content="${this.config.authorTwitter}" />
+        <meta name="twitter:title" content="${this.title}" />
+        <meta name="twitter:description" content="${this.description}" />
+        <meta name="twitter:image" content="${this.imageURL}" />`;
+  }
+
+  // https://ogp.me/
+  openGraph(type, articleObj) {
+    const result = `<meta property="og:type" content="${type}" />
+        <meta property="og:site_name" content="${this.config.blogName}" />
+        <meta property="og:url" content="${this.url}" />
+        <meta property="og:title" content="${this.title}" />
+        <meta property="og:description" content="${this.description}" />
+        <meta property="og:image" content="${this.imageURL}" />`;
+
+    if (type === "article" && articleObj) {
+      return (
+        result +
+        `
+        <meta property="article:author" content="${articleObj.authorName}" />
+        <meta property="article:published_time" content="${articleObj.publishedDate}" />
+        ${articleObj.tags.map((tag) => `<meta property="article:tag" content="${tag}">`).join("\n        ")}`
+      );
+    }
+    return result;
+  }
+
+  footer() {
+    const footerPath = path.join(this.config.themePath, "layouts", "partials", "footer.html");
+    const footerTemplate = fs.readFileSync(footerPath, "utf-8");
+
+    const funcFooter = new Function(
+      "config",
+      `return () => \`${footerTemplate}\`;`,
+    );
+    const result = funcFooter(this.config)();
+    const footerHTML = result
+      .split("\n")
+      .map((line, index) => (index !== 0 ? `              ${line}` : line))
+      .join("\n");
+
+    return footerHTML;
+  }
+
+  generateHTML(templatePath, data) {
+    const postTemplate = fs.readFileSync(templatePath, "utf-8");
+
+    const funcPost = new Function(
+      "page, data",
+      `return () => \`${postTemplate}\`;`,
+    );
+    const result = funcPost(this, data)();
+    const postHTML = result
+      .split("\n")
+      .map((line, index) => (index !== 0 ? `${line}` : line))
+      .join("\n");
+
+    return postHTML;
+  }
+};

package/lib/new.js

@@ -1,48 +1,48 @@
-const fs = require("fs");
-const path = require("path");
-
-function createPost(config, title) {
-  const postsDir = config.dev.postsdir;
-  const postDir = path.join(postsDir, title);
-
-  if (fs.existsSync(postDir)) {
-    console.error(`Error: Post "${title}" already exists at ${postDir}`);
-    process.exit(1);
-  }
-
-  // Ensure the posts directory exists
-  fs.mkdirSync(postsDir, { recursive: true });
-
-  // Create the post directory and images subdirectory
-  fs.mkdirSync(postDir, { recursive: true });
-  fs.mkdirSync(path.join(postDir, "images"), { recursive: true });
-
-  // Generate today's date in YYYY-MM-DD format
-  const today = new Date();
-  const dateStr = today.toISOString().split("T")[0];
-
-  // Copy placeholder image to the post's images directory
-  const placeholderSrc = path.join(__dirname, "assets", "placeholder.svg");
-  const placeholderDest = path.join(postDir, "images", "placeholder.svg");
-  if (fs.existsSync(placeholderSrc)) {
-    fs.copyFileSync(placeholderSrc, placeholderDest);
-  }
-
-  // Write index.md with front-matter
-  const frontMatter = `---
-title: ${title}
-date: ${dateStr}
-description: ""
-image: "placeholder.svg"
-tags: ""
----
-`;
-
-  fs.writeFileSync(path.join(postDir, "index.md"), frontMatter);
-
-  console.log(`Created new post: ${postDir}`);
-  console.log(`  - ${path.join(postDir, "index.md")}`);
-  console.log(`  - ${path.join(postDir, "images/")}`);
-}
-
-module.exports = { createPost };
+const fs = require("fs");
+const path = require("path");
+
+function createPost(config, title) {
+  const postsDir = config.dev.postsdir;
+  const postDir = path.join(postsDir, title);
+
+  if (fs.existsSync(postDir)) {
+    console.error(`Error: Post "${title}" already exists at ${postDir}`);
+    process.exit(1);
+  }
+
+  // Ensure the posts directory exists
+  fs.mkdirSync(postsDir, { recursive: true });
+
+  // Create the post directory and images subdirectory
+  fs.mkdirSync(postDir, { recursive: true });
+  fs.mkdirSync(path.join(postDir, "images"), { recursive: true });
+
+  // Generate today's date in YYYY-MM-DD format
+  const today = new Date();
+  const dateStr = today.toISOString().split("T")[0];
+
+  // Copy placeholder image to the post's images directory
+  const placeholderSrc = path.join(__dirname, "assets", "placeholder.svg");
+  const placeholderDest = path.join(postDir, "images", "placeholder.svg");
+  if (fs.existsSync(placeholderSrc)) {
+    fs.copyFileSync(placeholderSrc, placeholderDest);
+  }
+
+  // Write index.md with front-matter
+  const frontMatter = `---
+title: ${title}
+date: ${dateStr}
+description: ""
+image: "placeholder.svg"
+tags: ""
+---
+`;
+
+  fs.writeFileSync(path.join(postDir, "index.md"), frontMatter);
+
+  console.log(`Created new post: ${postDir}`);
+  console.log(`  - ${path.join(postDir, "index.md")}`);
+  console.log(`  - ${path.join(postDir, "images/")}`);
+}
+
+module.exports = { createPost };

package/lib/posts.js

@@ -1,42 +1,47 @@
-const fs = require("fs");
-const Page = require("./mod/page");
-
-module.exports = class Posts {
-  constructor(config) {
-    this.config = config;
-    this.posts = [];
-  }
-
-  // Read all markdown articles from content/posts and sort them by date
-  createPostObjects() {
-    const postPaths = fs.readdirSync(this.config.dev.postsdir);
-    postPaths.forEach((postPath) => {
-      const indexPath = `${this.config.dev.postsdir}/${postPath}/index.md`;
-      if (!fs.existsSync(indexPath)) {
-        console.warn(`Skipping "${postPath}": no index.md found`);
-        return;
-      }
-      const post = new Page(this.config);
-      post.readSource(`${this.config.dev.postsdir}/${postPath}`);
-      post.url = `${this.config.blogsite}/${post.path}/`;
-      post.imageURL = `${this.config.blogsite}/${post.path}/images/${post.image}`;
-      this.posts.push(post);
-    });
-    // sort by date
-    this.posts.sort(function (a, b) {
-      return new Date(b.date) - new Date(a.date);
-    });
-
-    // loop through posts and add previous and next post to each post
-    for (let i = 0; i < this.posts.length; i++) {
-      if (i > 0) {
-        this.posts[i].next = this.posts[i - 1];
-      }
-      if (i < this.posts.length - 1) {
-        this.posts[i].previous = this.posts[i + 1];
-      }
-    }
-
-    return this.posts;
-  }
-};
+const fs = require("fs");
+const path = require("path");
+const Page = require("./mod/page");
+
+module.exports = class Posts {
+  constructor(config) {
+    this.config = config;
+    this.posts = [];
+  }
+
+  // Read all markdown articles from content/posts and sort them by date
+  createPostObjects() {
+    if (!fs.existsSync(this.config.dev.postsdir)) {
+      console.warn(`No posts directory found at "${this.config.dev.postsdir}", skipping posts.`);
+      return;
+    }
+    const postPaths = fs.readdirSync(this.config.dev.postsdir);
+    postPaths.forEach((postPath) => {
+      const indexPath = path.join(this.config.dev.postsdir, postPath, "index.md");
+      if (!fs.existsSync(indexPath)) {
+        console.warn(`Skipping "${postPath}": no index.md found`);
+        return;
+      }
+      const post = new Page(this.config);
+      post.readSource(path.join(this.config.dev.postsdir, postPath));
+      post.url = `${this.config.blogsite}/${post.path}/`;
+      post.imageURL = `${this.config.blogsite}/${post.path}/images/${post.image}`;
+      this.posts.push(post);
+    });
+    // sort by date
+    this.posts.sort(function (a, b) {
+      return new Date(b.date) - new Date(a.date);
+    });
+
+    // loop through posts and add previous and next post to each post
+    for (let i = 0; i < this.posts.length; i++) {
+      if (i > 0) {
+        this.posts[i].next = this.posts[i - 1];
+      }
+      if (i < this.posts.length - 1) {
+        this.posts[i].previous = this.posts[i + 1];
+      }
+    }
+
+    return this.posts;
+  }
+};

package/lib/server.js

@@ -1,14 +1,20 @@
-const express = require("express");
-
-function serve(config, port) {
-  const app = express();
-  const PORT = port || process.env.PORT || 3000;
-
-  app.use(express.static(config.dev.outdir));
-
-  app.listen(PORT, () => {
-    console.log(`fossbook dev server running at http://localhost:${PORT}`);
-  });
-}
-
-module.exports = { serve };
+const express = require("express");
+
+function serve(config, port) {
+  const app = express();
+  const PORT = port || process.env.PORT || 3000;
+
+  const basePath = config.basePath || "/";
+  app.use(basePath, express.static(config.dev.outdir));
+
+  // Redirect root to basePath if basePath is not "/"
+  if (basePath !== "/") {
+    app.get("/", (req, res) => res.redirect(basePath));
+  }
+
+  app.listen(PORT, () => {
+    console.log(`fossbook dev server running at http://localhost:${PORT}`);
+  });
+}
+
+module.exports = { serve };