fossbook 0.0.2

package/lib/mod/page_base.js

@@ -0,0 +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;
+  }
+};

package/lib/new.js

@@ -0,0 +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 };

package/lib/posts.js

@@ -0,0 +1,42 @@
+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;
+  }
+};

package/lib/server.js

@@ -0,0 +1,14 @@
+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 };

package/lib/tag/index.js

@@ -0,0 +1,69 @@
+const fs = require("fs");
+const path = require("path");
+
+const PageBase = require("../mod/page_base");
+const TagPage = require("./tag");
+
+module.exports = class TagList extends PageBase {
+  constructor(config) {
+    super(config);
+  }
+
+  gatherTags(posts) {
+    const tags = new Map();
+    posts.forEach((post) => {
+      post.tags.forEach((tag) => {
+        if (!tags.has(tag)) {
+          tags.set(tag, []);
+        }
+        tags.get(tag).push({
+          path: post.path,
+          title: post.title,
+          date: post.date,
+          description: post.description,
+        });
+      });
+    });
+
+    return tags;
+  }
+
+  generateContent(articles) {
+    const tagMap = this.gatherTags(articles);
+
+    let tagArray = [];
+    for (let [tag, posts] of tagMap) {
+      tagArray.push({
+        name: tag,
+        path: tag.replace(/\s+/g, "_"),
+        count: posts.length,
+      });
+    }
+
+    tagArray.sort((a, b) => a.name.localeCompare(b.name));
+
+    if (!fs.existsSync(`${this.config.dev.outdir}/tags/`))
+      fs.mkdirSync(`${this.config.dev.outdir}/tags/`);
+
+    this.imageURL = this.config.image;
+    this.description = "Tag List";
+    const data = { tags: tagArray, pageTitle: "All tags" };
+    this.url = `${this.config.blogsite}/tag_list.html`;
+    this.title = `${this.config.blogName}: ${data.pageTitle}`;
+
+    const templatePath = path.join(this.config.themePath, "layouts", "tag_list.html");
+    fs.writeFile(
+      `${this.config.dev.outdir}/tags/index.html`,
+      this.generateHTML(templatePath, data),
+      (e) => {
+        if (e) throw e;
+        console.log(`tags/index.html for tags was created successfully`);
+      },
+    );
+
+    const tagPage = new TagPage(this.config);
+    for (let [tag, posts] of tagMap) {
+      tagPage.createPages(tag, posts);
+    }
+  }
+};

package/lib/tag/tag.js

@@ -0,0 +1,29 @@
+const fs = require("fs");
+const path = require("path");
+const PageBase = require("../mod/page_base");
+
+module.exports = class TagPage extends PageBase {
+  createPages(tag, posts) {
+    let tagPath = tag.replace(/\s+/g, "_"); // Replace spaces with underscores
+    if (!fs.existsSync(`${this.config.dev.outdir}/tags/${tagPath}`))
+      fs.mkdirSync(`${this.config.dev.outdir}/tags/${tagPath}`);
+
+    // FIXME: imageURL should refer to the image related to the tag
+    this.imageURL = this.config.image;
+
+    const data = { tag: tag, posts: posts, url: "tags/" + tagPath };
+    this.url = `${this.config.blogsite}/${data.url}`;
+    this.title = `${this.config.blogName}: Entries tagged - ${data.tag}`;
+    this.description = `List up all posts including '${data.tag}' tag.`;
+
+    const templatePath = path.join(this.config.themePath, "layouts", "tag.html");
+    fs.writeFile(
+      `${this.config.dev.outdir}/tags/${tagPath}/index.html`,
+      this.generateHTML(templatePath, data),
+      (e) => {
+        if (e) throw e;
+        console.log(`/tags/${tagPath}/index.html was created successfully`);
+      },
+    );
+  }
+};

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "fossbook",
+  "version": "0.0.2",
+  "description": "A lightweight static blog site generator for GitHub Pages",
+  "main": "lib/index.js",
+  "scripts": {
+    "build": "node bin/fossbook.js build",
+    "start": "node bin/fossbook.js serve",
+    "test": "mocha test",
+    "prettier": "prettier --write ."
+  },
+  "keywords": [
+    "static-site-generator",
+    "blog",
+    "github-pages",
+    "markdown"
+  ],
+  "author": "Joone Hur",
+  "license": "BSD-3-Clause",
+  "dependencies": {
+    "express": "^4.19.1",
+    "front-matter": "^4.0.2",
+    "highlight.js": "^11.9.0",
+    "marked": "^12.0.1"
+  },
+  "devDependencies": {
+    "mocha": "^10.2.0",
+    "prettier": "^3.2.5"
+  },
+  "bin": {
+    "fossbook": "bin/fossbook.js"
+  },
+  "engines": {
+    "node": ">=18"
+  },
+  "files": [
+    "bin/",
+    "lib/",
+    "themes/"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/joone/fossbook"
+  }
+}

package/themes/archie/assets/fonts/OFL.txt

@@ -0,0 +1,93 @@
+Copyright 2014 The Comic Neue Project Authors (https://github.com/crozynski/comicneue)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.