portosaurus 1.14.0

package/template/static/README.md

@@ -0,0 +1,33 @@
+# Static Assets
+
+Place your static files here. Everything in this directory will be copied to the root of your built website.
+
+## Common Files
+
+- **Binaries/scripts:** Install scripts or binaries
+- **Favicon:** `favicon.ico` or `favicon.png`
+- **Images:** `img/` directory for site images
+- **Documents:** PDFs, downloads, etc.
+- **robots.txt:** Search engine instructions
+- **CNAME:** Custom domain configuration (for GitHub Pages)
+
+## Example Structure
+
+```
+static/
+├── favicon.ico
+├── img/
+│   ├── logo.svg
+│   └── social-card.jpg
+├── downloads/
+│   └── resume.pdf
+└── robots.txt
+```
+
+## Usage
+
+Files in this directory are served at the root URL:
+
+- `static/favicon.ico` → `https://yoursite.com/favicon.ico`
+- `static/img/logo.svg` → `https://yoursite.com/img/logo.svg`
+- `static/downloads/resume.pdf` → `https://yoursite.com/downloads/resume.pdf`

package/utils/createConfig.js

@@ -0,0 +1,227 @@
+import { themes } from "prism-react-renderer";
+import { createRequire } from "module";
+import path from "path";
+import { fileURLToPath } from "url";
+
+const require = createRequire(import.meta.url);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const internalUtils = path.resolve(__dirname, "../internal/src/utils");
+
+/**
+ * Resolves the site URL based on config value and environment.
+ * @param {string} configValue - The site_url value from user config.
+ * @returns {string} Resolved URL.
+ */
+function resolveSiteUrl(configValue) {
+  if (configValue === "auto") {
+    if (process.env.GITHUB_ACTIONS === "true") {
+      const repoOwner = process.env.GITHUB_REPOSITORY_OWNER;
+      return `https://${repoOwner}.github.io`;
+    }
+    return "http://localhost";
+  }
+  return configValue;
+}
+
+/**
+ * Resolves the base path based on config value and environment.
+ * @param {string} configValue - The site_path value from user config.
+ * @returns {string} Resolved base path.
+ */
+function resolveBasePath(configValue) {
+  if (configValue === "auto") {
+    if (process.env.GITHUB_ACTIONS === "true") {
+      const repoName = process.env.GITHUB_REPOSITORY?.split("/")[1];
+      const repoOwner = process.env.GITHUB_REPOSITORY_OWNER;
+
+      // User/org pages use root path, project pages use /repo-name/
+      return repoName === `${repoOwner}.github.io` ? "/" : `/${repoName}/`;
+    }
+    return "/";
+  }
+  return configValue;
+}
+
+/**
+ * Creates a Docusaurus config from the Portosaurus user config.
+ * @param {Object} userConfig - The user configuration object (export of config.js).
+ * @returns {Object} Docusaurus configuration object.
+ **/
+export function createConfig(userConfig, projectRoot = process.cwd()) {
+  const usrConf = userConfig.usrConf || {};
+
+  //------------- Basic mapping -------------
+
+  const projName = usrConf.hero_section?.title || "Portosaurus Site";
+  const projDesc =
+    usrConf.hero_section?.description ||
+    "Complete portfolio cum personal website solution for your digital personality.";
+
+  const siteUrl = resolveSiteUrl(usrConf.site_url);
+  const sitePath = resolveBasePath(usrConf.site_path);
+  const faviconPath =
+    usrConf.hero_section?.profile_pic || "https://github.com/soymadip.png";
+
+  const title = usrConf.hero_section?.title || projName;
+  const tagline = usrConf.hero_section?.description || projDesc;
+
+  // Resolve paths relative to project root (where config.js is)
+  const notesPath = path.resolve(projectRoot, "notes");
+  const blogPath = path.resolve(projectRoot, "blog");
+  const staticPath = path.resolve(projectRoot, "static");
+
+  // ---------- Docusaurus Config -----------
+  const config = {
+    projectName: projName,
+
+    title: projName,
+    tagline: projDesc,
+
+    favicon: faviconPath,
+    url: siteUrl,
+    baseUrl: sitePath,
+
+    onBrokenLinks: "warn",
+    organizationName: projName,
+
+    customFields: {
+      heroSection: usrConf.hero_section || {},
+      aboutMe: usrConf.about_section || {},
+      projects: usrConf.projects_section || {},
+      socialLinks: usrConf.social_links || {},
+      experience: usrConf.experience_section || {},
+      tasksPage: usrConf.tasks_page || {},
+    },
+
+    // Markdown configuration
+    markdown: {
+      hooks: {
+        onBrokenMarkdownLinks: "warn",
+      },
+    },
+
+    presets: [
+      [
+        "classic",
+        /** @type {import('@docusaurus/preset-classic').Options} */
+        ({
+          docs: {
+            path: notesPath,
+            routeBasePath: "notes",
+            sidebarPath: "./sidebars.js", // Inside .portosaurus
+            // editUrl: '...',
+          },
+          blog: {
+            path: blogPath,
+            showReadingTime: true,
+            onUntruncatedBlogPosts: "ignore",
+            // editUrl: '...',
+          },
+          theme: {
+            customCss: "./src/css/custom.css", // Inside .portosaurus
+          },
+        }),
+      ],
+    ],
+
+    staticDirectories: [staticPath],
+
+    themeConfig:
+      /** @type {import('@docusaurus/preset-classic').ThemeConfig} */
+      ({
+        // Replace with your project's social card
+        image: usrConf.social_card || "img/social-card.jpg",
+
+        docs: {
+          sidebar: {
+            hideable: usrConf.collapsable_sidebar ?? true,
+          },
+        },
+
+        imageZoom: {
+          options: {
+            margin: 2,
+            background: "rgba(var(--ifm-background-color-rgb), 0.9)",
+          },
+        },
+
+        // Default: Dark mode
+        colorMode: {
+          defaultMode: usrConf.dark_mode ? "dark" : "light",
+          disableSwitch: usrConf.disable_theme_switch || false,
+        },
+
+        navbar: {
+          title: projName,
+          hideOnScroll: usrConf.hide_navbar_on_scroll ?? true,
+          logo: {
+            alt: "Logo",
+            src: usrConf.hero_section?.profile_pic || "img/logo.svg",
+          },
+          items: [
+            // Search will be added by plugin
+            {
+              type: "search",
+              position: "right",
+              className: "navbar-search-bar",
+            },
+            {
+              // About/Projects/Experience handled by home page logic
+              label: "About Me",
+              to: "/#about",
+              position: "right",
+            },
+            {
+              label: "Projects",
+              to: "/#projects",
+              position: "right",
+            },
+            {
+              type: "docSidebar",
+              sidebarId: "notes",
+              position: "right",
+              label: "Notes",
+            },
+            { to: "/blog", label: "Blog", position: "right" },
+            // TODO: Add Tasks link
+          ],
+        },
+        footer: {
+          style: "dark",
+          links: [
+            // TODO: Add footer links based on config
+          ],
+          copyright: `Copyright © ${new Date().getFullYear()} ${projName}. Built with Portosaurus.`,
+        },
+        prism: {
+          theme: themes.github,
+          darkTheme: themes.dracula,
+          additionalLanguages: ["java", "php", "bash"],
+        },
+      }),
+
+    plugins: [
+      // require.resolve(`${internalUtils}/generateFavicon.js`),
+      require.resolve(`${internalUtils}/generateRobotsTxt.js`),
+      [
+        require.resolve("@easyops-cn/docusaurus-search-local"),
+        {
+          hashed: true,
+          indexDocs: true,
+          docsDir: notesPath,
+          blogDir: blogPath,
+          docsRouteBasePath: "notes",
+          highlightSearchTermsOnTargetPage: true,
+          explicitSearchResultPath: true,
+          hideSearchBarWithNoSearchContext: true,
+          searchContextByPaths: ["notes", "blog"],
+          language: ["en"],
+        },
+      ],
+      "plugin-image-zoom",
+    ],
+  };
+
+  return config;
+}

package/utils/logger.js

@@ -0,0 +1,19 @@
+import chalk from 'chalk';
+
+export const logger = {
+  info: (msg) => {
+    console.log(`${chalk.blue('ℹ')} ${msg}`);
+  },
+  success: (msg) => {
+    console.log(`${chalk.green('✔')} ${msg}`);
+  },
+  warn: (msg) => {
+    console.log(`${chalk.yellow('⚠')} ${msg}`);
+  },
+  error: (msg) => {
+    console.error(`${chalk.red('✖')} ${msg}`);
+  },
+  tip: (msg) => { 
+    console.log(`${chalk.cyan('💡')} ${msg}`);
+  }
+};

package/utils/packageManager.js

@@ -0,0 +1,88 @@
+import fs from "fs-extra";
+import path from "path";
+import { execSync } from "child_process";
+
+/**
+ * Detect which package manager is being used in the project
+ **/
+export function detectPackageManager(projectRoot) {
+  // Check for lockfiles
+  if (
+    fs.existsSync(path.join(projectRoot, "bun.lockb")) ||
+    fs.existsSync(path.join(projectRoot, "bun.lock"))
+  ) {
+    return "bun";
+  }
+  if (fs.existsSync(path.join(projectRoot, "pnpm-lock.yaml"))) {
+    return "pnpm";
+  }
+  if (fs.existsSync(path.join(projectRoot, "yarn.lock"))) {
+    return "yarn";
+  }
+  if (fs.existsSync(path.join(projectRoot, "package-lock.json"))) {
+    return "npm";
+  }
+
+  // Fallback: check which is available in PATH
+  const managers = ["bun", "pnpm", "yarn", "npm"];
+  for (const manager of managers) {
+    try {
+      execSync(`${manager} --version`, { stdio: "ignore" });
+      return manager;
+    } catch {
+      // Not available
+    }
+  }
+
+  return "npm"; // Ultimate fallback
+}
+
+/**
+ * Get the command to run a package binary
+ * Different package managers have different ways to run binaries
+ */
+export function getRunCommand(packageManager, binaryName, args = []) {
+  switch (packageManager) {
+    case "bun":
+      // Bun can run binaries directly with `bun run`
+      return {
+        command: "bun",
+        args: ["run", binaryName, ...args],
+      };
+    case "pnpm":
+      // pnpm uses `pnpm exec`
+      return {
+        command: "pnpm",
+        args: ["exec", binaryName, ...args],
+      };
+    case "yarn":
+      // Yarn uses `yarn run`
+      return {
+        command: "yarn",
+        args: ["run", binaryName, ...args],
+      };
+    case "npm":
+    default:
+      // npm uses `npx`
+      return {
+        command: "npx",
+        args: [binaryName, ...args],
+      };
+  }
+}
+
+/**
+ * Find the docusaurus binary path
+ * Falls back to using package manager's run command if not found
+ */
+export function findDocusaurusBin(projectRoot) {
+  const packageManager = detectPackageManager(projectRoot);
+  const runCmd = getRunCommand(packageManager, "docusaurus");
+
+  return {
+    type: "managed",
+    command: runCmd.command,
+    args: runCmd.args,
+    packageManager,
+  };
+}