portosaurus 1.16.0 → 1.16.1

package/bin/portosaurus.js

@@ -57,25 +57,34 @@ async function prepareDocusaurusRun(projectRoot) {
 
   // Ensure internal files are synced to .portosaurus
   const internalDir = path.join(__dirname, "../src/internal");
-  const dotPorto = path.join(projectRoot, ".portosaurus");
+  const runtimeDir = path.join(projectRoot, ".portosaurus");
 
   // Ensure .portosaurus exists and is clean
-  fs.emptyDirSync(dotPorto);
+  fs.emptyDirSync(runtimeDir);
+
+  // Ensure user has essential folders in project root
+  fs.ensureDirSync(path.join(projectRoot, "notes"));
+  fs.ensureDirSync(path.join(projectRoot, "blog"));
+  fs.ensureDirSync(path.join(projectRoot, "static"));
 
   // 1. Copy everything from internal to .portosaurus
-  fs.copySync(internalDir, dotPorto);
+  fs.copySync(internalDir, runtimeDir);
 
   // 2. Overwrite with user files if they exist in project root
-  const internalFiles = readdirSync(internalDir);
-
-  for (const file of internalFiles) {
-    const userFile = path.join(projectRoot, file);
+  const syncItems = [
+    ...new Set([...readdirSync(internalDir), "blog", "static"]),
+  ];
+  for (const file of syncItems) {
+    const userFile = path.resolve(projectRoot, file);
+    const destFile = path.resolve(runtimeDir, file);
 
     if (existsSync(userFile)) {
-      fs.copySync(userFile, path.join(dotPorto, file), {
+      if (fs.statSync(userFile).isDirectory()) {
+        fs.ensureDirSync(destFile);
+      }
+      fs.copySync(userFile, destFile, {
         overwrite: true,
         filter: (src) => {
-          // Ignore notes/index.md
           if (src.endsWith(path.join("notes", "index.md"))) {
             return false;
           }
@@ -85,15 +94,6 @@ async function prepareDocusaurusRun(projectRoot) {
     }
   }
 
-  // Ensure user has essential folders
-  const userRootNotes = path.join(projectRoot, "notes");
-  const userRootBlog = path.join(projectRoot, "blog");
-  const userRootStatic = path.join(projectRoot, "static");
-
-  fs.ensureDirSync(userRootNotes);
-  fs.ensureDirSync(userRootBlog);
-  fs.ensureDirSync(userRootStatic);
-
   // Load user config
   const require = createRequire(import.meta.url);
 
@@ -120,7 +120,7 @@ async function prepareDocusaurusRun(projectRoot) {
   const docusaurusConfig = createConfig(userConfig, projectRoot);
 
   // Write temp config file INSIDE .portosaurus
-  const tempConfigPath = path.join(dotPorto, "docusaurus.config.js");
+  const tempConfigPath = path.join(runtimeDir, "docusaurus.config.js");
 
   const configContent = `// Auto-generated by Portosaurus
 module.exports = ${JSON.stringify(docusaurusConfig, null, 2)};`;
@@ -128,10 +128,10 @@ module.exports = ${JSON.stringify(docusaurusConfig, null, 2)};`;
   writeFileSync(tempConfigPath, configContent);
   logger.success("Generated Docusaurus config in .portosaurus.");
 
-  return { dotPorto };
+  return { runtimeDir };
 }
 
-async function runDocusaurus(command, args, dotPorto, projectRoot) {
+async function runDocusaurus(command, args, runtimeDir, projectRoot) {
   // Detect package manager and find docusaurus binary
   const { findDocusaurusBin } = await import("../src/utils/packageManager.js");
   const docusaurus = findDocusaurusBin(projectRoot || process.cwd());
@@ -142,7 +142,7 @@ async function runDocusaurus(command, args, dotPorto, projectRoot) {
 
   const child = spawn(
     docusaurus.command,
-    [...docusaurus.args, command, dotPorto, ...args],
+    [...docusaurus.args, command, runtimeDir, ...args],
     {
       stdio: "inherit",
       cwd: projectRoot,
@@ -302,8 +302,6 @@ program
     }
   });
 
-
-
 // --- START COMMAND ---
 
 program
@@ -314,8 +312,8 @@ program
     const projectRoot = process.cwd();
     logger.info("Starting development server...");
     try {
-      const { dotPorto } = await prepareDocusaurusRun(projectRoot);
-      await runDocusaurus("start", [], dotPorto, projectRoot);
+      const { runtimeDir } = await prepareDocusaurusRun(projectRoot);
+      await runDocusaurus("start", [], runtimeDir, projectRoot);
     } catch (error) {
       logger.error(`Failed to start: ${error.message}`);
       process.exit(1);
@@ -334,12 +332,12 @@ program
     logger.info("Building Portosaurus site...");
 
     try {
-      const { dotPorto } = await prepareDocusaurusRun(projectRoot);
+      const { runtimeDir } = await prepareDocusaurusRun(projectRoot);
 
       const buildDir = path.join(projectRoot, "build");
       const args = ["--out-dir", buildDir];
 
-      await runDocusaurus("build", args, dotPorto, projectRoot);
+      await runDocusaurus("build", args, runtimeDir, projectRoot);
 
       // Create .nojekyll for GitHub Pages compatibility
       const nojekyllPath = path.join(buildDir, ".nojekyll");
@@ -368,7 +366,7 @@ program
     logger.info("Serving Portosaurus site...");
 
     try {
-      const { dotPorto } = await prepareDocusaurusRun(projectRoot);
+      const { runtimeDir } = await prepareDocusaurusRun(projectRoot);
       const buildDir = path.join(projectRoot, "build");
 
       if (!existsSync(buildDir)) {
@@ -378,7 +376,12 @@ program
         process.exit(1);
       }
 
-      await runDocusaurus("serve", ["--dir", buildDir], dotPorto, projectRoot);
+      await runDocusaurus(
+        "serve",
+        ["--dir", buildDir],
+        runtimeDir,
+        projectRoot,
+      );
     } catch (error) {
       logger.error(`Failed to serve: ${error.message}`);
       process.exit(1);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "portosaurus",
-  "version": "1.16.0",
+  "version": "1.16.1",
   "author": "soymadip",
   "license": "GPL-3.0-only",
   "description": "Complete portfolio cum personal website solution for your digital personality.",

package/src/utils/createConfig.js

@@ -5,9 +5,11 @@ 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");
 
+
+//---------------------- helpers -------------------------
+
 /**
  * Resolves the site URL based on config value and environment.
  * @param {string} configValue - The site_url value from user config.
@@ -43,12 +45,15 @@ function resolveBasePath(configValue) {
   return configValue;
 }
 
+//--------------------- Config Creation ---------------------
+
 /**
  * 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 -------------
@@ -63,14 +68,11 @@ export function createConfig(userConfig, projectRoot = process.cwd()) {
   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 .portosaurus (the build context)
-  const dotPorto = path.resolve(projectRoot, ".portosaurus");
-  const notesPath = path.resolve(dotPorto, "notes");
-  const blogPath = path.resolve(dotPorto, "blog");
-  const staticPath = path.resolve(dotPorto, "static");
+  const runtimeDir = path.resolve(projectRoot, ".portosaurus");
+  const notesPath = path.resolve(runtimeDir, "notes");
+  const blogPath = path.resolve(runtimeDir, "blog");
+  const staticPath = path.resolve(runtimeDir, "static");
 
   // ---------- Docusaurus Config -----------
   const config = {
@@ -210,8 +212,8 @@ export function createConfig(userConfig, projectRoot = process.cwd()) {
         {
           hashed: true,
           indexDocs: true,
-          docsDir: notesPath,
-          blogDir: blogPath,
+          docsDir: "notes",
+          blogDir: "blog",
           docsRouteBasePath: "notes",
           highlightSearchTermsOnTargetPage: true,
           explicitSearchResultPath: true,

package/src/utils/ss.js

@@ -0,0 +1,294 @@
+import { catppuccinMocha, catppuccinLatte } from "./src/config/prism.js";
+import { appVersion } from "./src/utils/appVersion.js";
+import { metaTags } from "./src/config/metaTags.js";
+import { usrConf } from "./src/utils/compileConfig.js";
+import { useEnabled } from "./src/utils/filterEnabledItems.js";
+
+const projectName = "Portosaurus";
+const projectVersion = appVersion();
+const faviconPath = 'favicon/favicon.ico';
+const iconPicPath = 'static/img/icon.png';
+
+const config = {
+
+  projectName: `${projectName}`,
+
+  title: usrConf.hero_section.title || `${projectName}`,
+
+  tagline: usrConf.hero_section.tagline || "Your complete portfolio solution",
+
+  favicon: usrConf.favicon || `${faviconPath}`,
+
+  url: usrConf.site_url,
+  baseUrl: usrConf.site_path || "/",
+
+  // GH Pages config
+  organizationName: usrConf.hero_section.title || `${projectName} `,
+  deploymentBranch: "gh-pages",
+
+  onBrokenAnchors: "ignore",
+  onBrokenLinks: "warn",
+  // onBrokenMarkdownLinks: "warn",
+
+  i18n: {
+    defaultLocale: "en",
+    locales: ["en"],
+  },
+
+  headTags: metaTags,
+
+  customFields: {
+    version: `${projectVersion}`,
+
+    heroSection: {
+      profilePic: usrConf.hero_section.profile_pic || `${iconPicPath}`,
+      intro: usrConf.hero_section.intro || "Hello there, I'm",
+      title: usrConf.hero_section.title || "Your Name",
+      subtitle: usrConf.hero_section.subtitle || 'I am a',
+      profession: usrConf.hero_section.profession || 'Your Profession',
+      description: usrConf.hero_section.description || "Short description about your profession, passion, goals.",
+      learnMoreButtonTxt: usrConf.hero_section.learn__more_button_txt || "Learn More",
+    },
+
+    aboutMe: {
+      enable: usrConf.about_me.enable || true,
+
+      image:       usrConf.about_me.image || `${iconPicPath}`,
+      description: usrConf.about_me.description || [
+        "I'm a passionate FOSS developer with expertise in designing and building solutions for real-world problems.",
+        "My journey in software development started with a simple desire to automate repetitive tasks, specially in my PC.",
+      ],
+      skills: usrConf.about_me.skills || ["skill 1", "Skill 2"],
+      resumeLink: usrConf.about_me.resume_link || "https://example.com/resume",
+    },
+
+    projects: usrConf.project_shelf,
+
+    experience: usrConf.experience,
+
+    socialLinks: {
+      enable: usrConf.social_links.enable || true,
+
+      links: usrConf.social_links.links || [
+        {
+          name: "Your Instagram",
+          icon: "instagram",
+          desc: "Your Instagram profile link",
+          url: "https://instagram.com/yourprofile",
+        },
+      ],
+    },
+
+    robotsTxt: {
+      enable: usrConf.robots_txt || true,
+      rules: [
+        {
+          disallow: ["/notes/", "/tasks/"],
+        },
+      ],
+      customLines: [],
+    },
+
+    tasksPage: {
+      enable: usrConf.tasks_page.enable || true,
+      title: usrConf.tasks_page.title || "Tasks",
+      description: usrConf.tasks_page.description || "Track your tasks and projects here.",
+      taskList: usrConf.tasks_page.tasks || [
+        {
+          title: "Example Tasks",
+          description: "Description of the task",
+          status: "active",
+          priority: "high",
+        },
+      ],
+    },
+  },
+
+  presets: [
+    [
+      "classic",
+      {
+        docs: {
+          routeBasePath: "notes",
+          path: "notes",
+          sidebarPath: "./src/config/sidebar.js",
+
+          admonitions: {
+            keywords: ["note", "tip", "info", "warning", "danger", "question"],
+            extendDefaults: true,
+          },
+        },
+
+        blog: {
+
+          feedOptions: usrConf.rss
+            ? {
+                type: ["rss", "atom"],
+                xslt: true,
+              }
+            : undefined,
+
+          showReadingTime: false,
+
+          onInlineTags: "warn",
+          onInlineAuthors: "warn",
+          onUntruncatedBlogPosts: "warn",
+        },
+
+        theme: {
+          customCss: "./src/css/custom.css",
+        },
+
+      },
+    ],
+  ],
+
+  // themes: ['@docusaurus/theme-mermaid'],
+  markdown: {
+    mermaid: true,
+    hooks: {
+      onBrokenMarkdownLinks: "warn"
+    }
+  },
+
+  themeConfig: {
+    // Social card
+    image: usrConf.social_card || "img/social-card.jpeg",
+
+    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: usrConf.hero_section.title || `${projectName} `,
+      hideOnScroll: usrConf.hide_navbar_on_scroll || true,
+
+      logo: {
+        alt: "Site Logo",
+        src: usrConf.favicon || `${faviconPath}`,
+      },
+
+      items: useEnabled([
+        {
+          type: "search",
+          position: "right",
+          className: "navbar-search-bar",
+        },
+        {
+          enable: usrConf.about_me?.enable || true,
+          value: {
+            label: "About Me",
+            to: "/#about",
+            position: "right",
+            activeBaseRegex: "^/#about",
+          },
+        },
+        {
+          enable: usrConf.project_shelf?.enable || true,
+          value: {
+            label: "Projects",
+            to: "/#projects",
+            position: "right",
+            activeBaseRegex: "^/#projects",
+          },
+        },
+        {
+          enable: usrConf.experience?.enable || false,
+          value: {
+            label: "Experience",
+            to: "/#experience",
+            position: "right",
+            activeBaseRegex: "^/#experience",
+          },
+        },
+        {
+          enable: usrConf.social_links?.enable || true,
+          value: {
+            label: "Contact",
+            to: "/#contact",
+            position: "right",
+            activeBaseRegex: "^/$contact",
+          },
+        },
+        {
+          type: "dropdown",
+          label: "More",
+          position: "right",
+          className: "_navbar-more-items",
+          items: useEnabled([
+            { label: "Notes", to: "/notes" },
+            { label: "Blog", to: "/blog" },
+            { label: "Tasks", to: "/tasks" },
+            {
+              enable: usrConf.disable_branding ? false : true,
+              value: {
+                label: `Portosaurus v${projectVersion}`,
+                className: "_nav-protosaurus-version",
+                to: "https://github.com/soymadip/portosaurus",
+              },
+            },
+          ]),
+        }
+      ]),
+    },
+
+    tableOfContents: {
+      minHeadingLevel: 2,
+      maxHeadingLevel: 4,
+    },
+
+    prism: {
+      theme: catppuccinLatte,
+      darkTheme: catppuccinMocha,
+      additionalLanguages: ["java", "php", "bash"],
+    },
+
+    footer: {
+      /* links: [
+        {
+            label: 'GitHub',
+            href: 'https://github.com/',
+          }
+        ],
+        copyright: `Copyright © ${new Date().getFullYear()} ` + ownerName,
+      */
+    },
+  },
+
+  plugins: [
+    require.resolve("./src/utils/generateFavicon"),
+    require.resolve("./src/utils/generateRobotsTxt"),
+    [
+      require.resolve("@easyops-cn/docusaurus-search-local"),
+      {
+        hashed: true,
+        indexDocs: true,
+        docsDir: "notes",
+        docsRouteBasePath: "notes",
+        highlightSearchTermsOnTargetPage: true,
+        explicitSearchResultPath: true,
+        hideSearchBarWithNoSearchContext: true,
+        searchContextByPaths: ["notes", "blog"],
+        language: ["en"],
+      },
+    ],
+    "plugin-image-zoom",
+  ],
+};
+
+export default config;