portosaurus 2.1.10 → 2.1.12

package/README.md

@@ -137,7 +137,7 @@ module.exports = {
 - [Docusaurus](https://docusaurus.io/) - The static site builder framework this is built upon.
 - [React](https://react.dev) - UI library for building the interactive components.
 - [React Icons](https://react-icons.github.io/) - Icon library used throughout the site.
-- Libraries listed in [package.json](https://github.com/soymadip/portosaurus/blob/compiler/package.json#L16) - Essential dependencies.
+- Libraries listed in [package.json](./package.json) - Essential dependencies.
 - [Hugo Profile](https://hugo-profile.netlify.app/) - Design inspiration.
 - [Catppuccin](https://github.com/catppuccin/catppuccin) - Color scheme that inspired the site's palette.
 - [Deepseek R1](https://www.deepseek.com/) hosted using [Ollama](https://ollama.com/library/deepseek-r1) - prism.js theme & project card component.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "portosaurus",
-  "version": "2.1.10",
+  "version": "2.1.12",
   "private": false,
   "homepage": "https://github.com/soymadip/portosaurus",
   "repository": {

package/src/cli/init.mjs

@@ -5,7 +5,7 @@ import { getPackageManager } from "../utils/packageManager.mjs";
 import { PortoRoot, mirrorSync } from "../utils/cliHelpers.mjs";
 
 export async function initCommand(projectName, options) {
-  const projectDir = path.resolve(process.cwd(), projectName);
+  const UsrProjDir = path.resolve(process.cwd(), projectName);
   const templateDir = path.resolve(PortoRoot, "src/template");
   const packageJson = JSON.parse(
     fs.readFileSync(path.resolve(PortoRoot, "package.json"), "utf8"),
@@ -29,7 +29,10 @@ export async function initCommand(projectName, options) {
 
   const contentDirs = ["blog", "notes", "static"];
 
-  if (fs.existsSync(projectDir)) {
+  const dotGitIgnore = path.join(UsrProjDir, ".gitignore");
+  const plainGitIgnore = path.join(UsrProjDir, "gitignore");
+
+  if (fs.existsSync(UsrProjDir)) {
     logger.error(`Target Directory "${projectName}" already exists.`);
     process.exit(1);
   }
@@ -45,11 +48,11 @@ export async function initCommand(projectName, options) {
     const { execSync } = await import("child_process");
 
     // Create user project directory
-    fs.mkdirSync(projectDir, { recursive: true });
+    fs.mkdirSync(UsrProjDir, { recursive: true });
 
     // Git Init
     try {
-      execSync("git init", { cwd: projectDir, stdio: "ignore" });
+      execSync("git init", { cwd: UsrProjDir, stdio: "ignore" });
     } catch {
       logger.warn("Failed to initialize git repository.");
       process.exit(1);
@@ -57,12 +60,17 @@ export async function initCommand(projectName, options) {
 
     // Make Content directories
     for (const dir of contentDirs) {
-      fs.mkdirSync(path.join(projectDir, dir), { recursive: true });
+      fs.mkdirSync(path.join(UsrProjDir, dir), { recursive: true });
     }
 
     // Copy template files, dirs
     if (fs.existsSync(templateDir)) {
-      mirrorSync(templateDir, projectDir, TemplateVars, ignoreList);
+      mirrorSync(templateDir, UsrProjDir, TemplateVars, ignoreList);
+
+      // Rename gitignore to .gitignore (to bypass npm publish exclusions)
+      if (fs.existsSync(plainGitIgnore) && !fs.existsSync(dotGitIgnore)) {
+        fs.renameSync(plainGitIgnore, dotGitIgnore);
+      }
     } else {
       logger.error(`Portosaurus template directory not found: ${templateDir}`);
       process.exit(1);
@@ -72,13 +80,13 @@ export async function initCommand(projectName, options) {
     try {
       // Add all files to git
       execSync("git add .", {
-        cwd: projectDir,
+        cwd: UsrProjDir,
         stdio: "ignore",
       });
 
       // Initial Commit
       execSync('git commit -m "Initialize Portosaurus project"', {
-        cwd: projectDir,
+        cwd: UsrProjDir,
         stdio: "ignore",
       });
     } catch {
@@ -89,7 +97,7 @@ export async function initCommand(projectName, options) {
 
     // GitHub Pages setup
     if (options.githubPages === false) {
-      const ghDir = path.join(projectDir, ".github");
+      const ghDir = path.join(UsrProjDir, ".github");
 
       // Delete copied .github directory
       if (fs.existsSync(ghDir)) {
@@ -103,10 +111,10 @@ export async function initCommand(projectName, options) {
       );
     }
 
-    logger.success(`Created ${projectName} at ${projectDir}`);
+    logger.success(`Created ${projectName} at ${UsrProjDir}`);
 
     // Install dependencies
-    const pm = getPackageManager(projectDir);
+    const pm = getPackageManager(UsrProjDir);
 
     logger.info(`Installing dependencies with ${pm.name}...`);
 
@@ -114,7 +122,7 @@ export async function initCommand(projectName, options) {
       logger.info(`Running ${pm.install}...`);
       try {
         const { execSync } = await import("child_process");
-        execSync(pm.install, { cwd: projectDir, stdio: "inherit" });
+        execSync(pm.install, { cwd: UsrProjDir, stdio: "inherit" });
         logger.success("Dependencies installed!");
       } catch {
         logger.error(

package/src/core/buildDocuConfig.mjs

@@ -120,7 +120,7 @@ export function buildDocuConfig(rawUserConfig, UserRoot) {
     tagline: UserConfig.hero_section.description,
     favicon: resolveStaticAsset(
       UserConfig.favicon,
-      resolveStaticAsset(UserConfig.hero_section.profile_pic, "img/icon.png"),
+      resolveStaticAsset("favicon/favicon.ico", "img/icon.png"),
     ),
     url: siteUrl,
     baseUrl: basePath,

package/src/plugins/favicon.mjs

@@ -233,12 +233,18 @@ export async function generateFavicons(context, options = {}) {
 
     // Cleanup temporary files
     tempFiles.forEach(cleanupFile);
-    return true;
+    return {
+      success: true,
+      html: response.html || [],
+    };
   } catch (error) {
     logger.warn(`Favicon generation skipped: ${error.message}`);
     tempFiles.forEach(cleanupFile);
     // Don't throw - allow the build to continue
-    return false;
+    return {
+      success: false,
+      html: [],
+    };
   }
 }
 
@@ -251,6 +257,8 @@ export default function (context, options = {}) {
     generateOnDev = true,
   } = options;
 
+  let generatedTags = [];
+
   return {
     name: "favicon-generator",
 
@@ -262,13 +270,31 @@ export default function (context, options = {}) {
 
       if (shouldGenerate) {
         // Non-fatal execution
-        await generateFavicons(context, {
+        const result = await generateFavicons(context, {
           imagePath,
           outputPath,
           circular,
           shape,
         });
+        if (result.success) {
+          generatedTags = result.html;
+        }
+      }
+    },
+
+    injectHtmlTags() {
+      if (generatedTags.length > 0) {
+        return {
+          headTags: generatedTags.map((tag) => {
+            // Convert string tags to Docusaurus headTags objects if needed
+            // Actually Docusaurus supports returning a string or objects
+            // The simplest is to return the strings as raw HTML if possible
+            // But injectHtmlTags expects objects or strings
+            return tag;
+          }),
+        };
       }
+      return {};
     },
   };
 }

package/src/template/gitignore

@@ -0,0 +1,9 @@
+# gitignore, init time renamed
+
+node_modules/
+.docusaurus/
+.portosaurus/
+.cache-loader/
+build/
+notes/index.md*
+test*

package/src/template/notes/index.mdx

@@ -0,0 +1,9 @@
+---
+hide_table_of_contents: true
+---
+
+import NoteCards from "portosaurus/src/theme/components/NoteIndex/index.js";
+
+# Notes
+
+<NoteCards />

package/src/theme/config/metaTags.js

@@ -18,222 +18,4 @@ export const metaTags = [
       content: backgroundColor,
     },
   },
-
-  // Android Chrome icons
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "36x36",
-      href: "/favicon/android-chrome-36x36.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "48x48",
-      href: "/favicon/android-chrome-48x48.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "72x72",
-      href: "/favicon/android-chrome-72x72.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "96x96",
-      href: "/favicon/android-chrome-96x96.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "144x144",
-      href: "/favicon/android-chrome-144x144.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "192x192",
-      href: "/favicon/android-chrome-192x192.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "256x256",
-      href: "/favicon/android-chrome-256x256.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "384x384",
-      href: "/favicon/android-chrome-384x384.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "512x512",
-      href: "/favicon/android-chrome-512x512.png",
-    },
-  },
-
-  // Apple touch icons
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "57x57",
-      href: "/favicon/apple-touch-icon-57x57.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "60x60",
-      href: "/favicon/apple-touch-icon-60x60.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "72x72",
-      href: "/favicon/apple-touch-icon-72x72.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "76x76",
-      href: "/favicon/apple-touch-icon-76x76.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "114x114",
-      href: "/favicon/apple-touch-icon-114x114.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "120x120",
-      href: "/favicon/apple-touch-icon-120x120.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "144x144",
-      href: "/favicon/apple-touch-icon-144x144.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "152x152",
-      href: "/favicon/apple-touch-icon-152x152.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "167x167",
-      href: "/favicon/apple-touch-icon-167x167.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "180x180",
-      href: "/favicon/apple-touch-icon-180x180.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon",
-      sizes: "1024x1024",
-      href: "/favicon/apple-touch-icon-1024x1024.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "apple-touch-icon-precomposed",
-      href: "/favicon/apple-touch-icon-precomposed.png",
-    },
-  },
-
-  // Standard favicons
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "16x16",
-      href: "/favicon/favicon-16x16.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "32x32",
-      href: "/favicon/favicon-32x32.png",
-    },
-  },
-  {
-    tagName: "link",
-    attributes: {
-      rel: "icon",
-      type: "image/png",
-      sizes: "48x48",
-      href: "/favicon/favicon-48x48.png",
-    },
-  },
-
-  // Web manifest
-  {
-    tagName: "link",
-    attributes: {
-      rel: "manifest",
-      href: "/favicon/manifest.webmanifest",
-    },
-  },
 ];

package/src/template/static/img/svg/icon-blog.svg

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg stroke="#fab387" fill="#2e8555" stroke-width="0" viewBox="0 0 448 512" color="#fab387" style="color:#fab387" height="24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M162.4 196c4.8-4.9 6.2-5.1 36.4-5.1 27.2 0 28.1.1 32.1 2.1 5.8 2.9 8.3 7 8.3 13.6 0 5.9-2.4 10-7.6 13.4-2.8 1.8-4.5 1.9-31.1 2.1-16.4.1-29.5-.2-31.5-.8-10.3-2.9-14.1-17.7-6.6-25.3zm61.4 94.5c-53.9 0-55.8.2-60.2 4.1-3.5 3.1-5.7 9.4-5.1 13.9.7 4.7 4.8 10.1 9.2 12 2.2 1 14.1 1.7 56.3 1.2l47.9-.6 9.2-1.5c9-5.1 10.5-17.4 3.1-24.4-5.3-4.7-5-4.7-60.4-4.7zm223.4 130.1c-3.5 28.4-23 50.4-51.1 57.5-7.2 1.8-9.7 1.9-172.9 1.8-157.8 0-165.9-.1-172-1.8-8.4-2.2-15.6-5.5-22.3-10-5.6-3.8-13.9-11.8-17-16.4-3.8-5.6-8.2-15.3-10-22C.1 423 0 420.3 0 256.3 0 93.2 0 89.7 1.8 82.6 8.1 57.9 27.7 39 53 33.4c7.3-1.6 332.1-1.9 340-.3 21.2 4.3 37.9 17.1 47.6 36.4 7.7 15.3 7-1.5 7.3 180.6.2 115.8 0 164.5-.7 170.5zm-85.4-185.2c-1.1-5-4.2-9.6-7.7-11.5-1.1-.6-8-1.3-15.5-1.7-12.4-.6-13.8-.8-17.8-3.1-6.2-3.6-7.9-7.6-8-18.3 0-20.4-8.5-39.4-25.3-56.5-12-12.2-25.3-20.5-40.6-25.1-3.6-1.1-11.8-1.5-39.2-1.8-42.9-.5-52.5.4-67.1 6.2-27 10.7-46.3 33.4-53.4 62.4-1.3 5.4-1.6 14.2-1.9 64.3-.4 62.8 0 72.1 4 84.5 9.7 30.7 37.1 53.4 64.6 58.4 9.2 1.7 122.2 2.1 133.7.5 20.1-2.7 35.9-10.8 50.7-25.9 10.7-10.9 17.4-22.8 21.8-38.5 3.2-10.9 2.9-88.4 1.7-93.9z"></path></svg>

package/src/template/static/img/svg/icon-note.svg

@@ -1,2 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<svg stroke="#fab387" fill="#2e8555" stroke-width="0" viewBox="0 0 448 512" color="#fab387" style="color:#fab387" height="24" width="24" xmlns="http://www.w3.org/2000/svg"><path d="M162.4 196c4.8-4.9 6.2-5.1 36.4-5.1 27.2 0 28.1.1 32.1 2.1 5.8 2.9 8.3 7 8.3 13.6 0 5.9-2.4 10-7.6 13.4-2.8 1.8-4.5 1.9-31.1 2.1-16.4.1-29.5-.2-31.5-.8-10.3-2.9-14.1-17.7-6.6-25.3zm61.4 94.5c-53.9 0-55.8.2-60.2 4.1-3.5 3.1-5.7 9.4-5.1 13.9.7 4.7 4.8 10.1 9.2 12 2.2 1 14.1 1.7 56.3 1.2l47.9-.6 9.2-1.5c9-5.1 10.5-17.4 3.1-24.4-5.3-4.7-5-4.7-60.4-4.7zm223.4 130.1c-3.5 28.4-23 50.4-51.1 57.5-7.2 1.8-9.7 1.9-172.9 1.8-157.8 0-165.9-.1-172-1.8-8.4-2.2-15.6-5.5-22.3-10-5.6-3.8-13.9-11.8-17-16.4-3.8-5.6-8.2-15.3-10-22C.1 423 0 420.3 0 256.3 0 93.2 0 89.7 1.8 82.6 8.1 57.9 27.7 39 53 33.4c7.3-1.6 332.1-1.9 340-.3 21.2 4.3 37.9 17.1 47.6 36.4 7.7 15.3 7-1.5 7.3 180.6.2 115.8 0 164.5-.7 170.5zm-85.4-185.2c-1.1-5-4.2-9.6-7.7-11.5-1.1-.6-8-1.3-15.5-1.7-12.4-.6-13.8-.8-17.8-3.1-6.2-3.6-7.9-7.6-8-18.3 0-20.4-8.5-39.4-25.3-56.5-12-12.2-25.3-20.5-40.6-25.1-3.6-1.1-11.8-1.5-39.2-1.8-42.9-.5-52.5.4-67.1 6.2-27 10.7-46.3 33.4-53.4 62.4-1.3 5.4-1.6 14.2-1.9 64.3-.4 62.8 0 72.1 4 84.5 9.7 30.7 37.1 53.4 64.6 58.4 9.2 1.7 122.2 2.1 133.7.5 20.1-2.7 35.9-10.8 50.7-25.9 10.7-10.9 17.4-22.8 21.8-38.5 3.2-10.9 2.9-88.4 1.7-93.9z"></path></svg>