portosaurus 1.14.0

package/README.md

@@ -0,0 +1,116 @@
+<div align="center">
+    <img src="https://raw.githubusercontent.com/soymadip/portosaurus/refs/heads/compiler/static/img/icon.png" width=150>
+    <h1>Portosaurus</h1>
+    <p>Complete portfolio cum personal website solution for your digital personality.</p>
+</div>
+
+<br/>
+
+## 🧩 Features
+
+- **📝 Full-featured Portfolio Site** — Showcase your work, skills, experience, social identity.
+- **🎨 Beautiful UI** — Responsive design with Catppuccin color scheme.
+- **🖼️ Project Showcase** — Interactive project cards with support for featured projects, project status badges, and tags
+- **📚 Knowledge Base** — Integrated notes system with custom icons and categorization
+- **✏️ Blog Platform** — Built-in blogging capabilities.
+- **📋 Task Tracking** — Track your plans with priority levels and completion status
+- **🛠️ Highly Configurable** — Extensive customization options in a central config file
+- **🔍 Powerful Search** — Integrated search functionality for notes and blog content
+- **📱 Mobile-Friendly** — Fully responsive design works on all devices
+- **🚀 Auto Deployment** — Ready for GitHub Pages or any static hosting
+
+<br/>
+
+## � Getting Started
+
+### 1. Create a New Project
+
+Run the initialization command to set up your portfolio:
+
+```bash
+# With Bun
+bunx portosaurus init my-portfolio
+
+# with npm
+npx portosaurus init my-portfolio
+```
+
+**Options:**
+
+- `-gh`: Automatically sets up GitHub Actions workflow for deployment.
+- `--install`: Installs dependencies automatically.
+
+### 2. Start Development
+
+Navigate to your project and start the development server:
+
+```bash
+cd my-portfolio
+
+# With npm
+npm run start
+
+# With Bun
+bun run start
+```
+
+Your site will be available at `http://localhost:3000`.
+
+### 3. Build & Deploy
+
+To generate the static site for production:
+
+```bash
+# With Bun 
+bun run build
+
+# With npm
+npm run build
+```
+
+The output will be in the `build/` directory.
+
+#### GitHub Pages (Automated)
+
+If you used the `-gh` flag during init, just push to your repository:
+
+1. Create a repository on GitHub.
+2. Push your code:
+   ```bash
+   git remote add origin https://github.com/username/repo.git
+   git branch -M main
+   git push -u origin main
+   ```
+3. Go to GitHub Settings > Pages > Build and deployment > Source > **GitHub Actions**.
+
+<br>
+
+## ⚙️ Configuration
+
+Portosaurus is configured via `config.js` in your project root.
+
+```javascript
+module.exports = {
+  usrConf: {
+    hero_section: {
+      title: "Your Name",
+      description: "Software Engineer",
+      // ...
+    },
+    // ...
+  },
+};
+```
+
+<br>
+
+## 📄 Credits
+
+- [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.
+- [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.
+- Countless Internet forum posts - Filling me with information.

package/bin/portosaurus.js

@@ -0,0 +1,337 @@
+#!/usr/bin/env node
+
+import { Command } from "commander";
+import fs from "fs-extra";
+const {
+  readFileSync,
+  writeFileSync,
+  existsSync,
+  mkdirSync,
+  mkdirpSync,
+  readdirSync,
+  copySync,
+  removeSync,
+} = fs;
+import path from "path";
+import chalk from "chalk";
+import { fileURLToPath } from "url";
+import { spawn, execSync } from "child_process";
+import { createRequire } from "module";
+
+import { logger } from "../utils/logger.js";
+import { createConfig } from "../utils/createConfig.js";
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+const packageJson = JSON.parse(
+  readFileSync(new URL("../package.json", import.meta.url)),
+);
+
+const program = new Command();
+
+program
+  .name("portosaurus")
+  .description("CLI for Portosaurus - The complete portfolio solution")
+  .version(packageJson.version);
+
+// ----------- HELPERS -------------
+
+async function prepareDocusaurusRun(projectRoot) {
+  const configPath = path.join(projectRoot, "config.js");
+
+  if (!existsSync(configPath)) {
+    console.log();
+    logger.error(
+      "config.js not found. Are you in a Portosaurus project directory?",
+    );
+    process.exit(1);
+  }
+
+  // Ensure internal files are synced to .portosaurus
+  const internalSrc = path.join(__dirname, "../internal/src");
+  const internalSidebars = path.join(__dirname, "../internal/sidebars.js");
+  const internalNotesIndex = path.join(__dirname, "../internal/notes/index.md");
+
+  const dotPorto = path.join(projectRoot, ".portosaurus");
+  const userSrc = path.join(dotPorto, "src");
+  const userSidebars = path.join(dotPorto, "sidebars.js");
+
+  // Ensure .portosaurus exists
+  fs.ensureDirSync(dotPorto);
+
+  // Always copy/overwrite src/
+  fs.copySync(internalSrc, userSrc);
+
+  // Always copy/overwrite sidebars.js
+  fs.copySync(internalSidebars, userSidebars);
+
+  // 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);
+
+  // Always ensure index.md exists (framework-managed file)
+  const userNotesIndex = path.join(userRootNotes, "index.md");
+  if (!fs.existsSync(userNotesIndex)) {
+    fs.copySync(internalNotesIndex, userNotesIndex);
+  }
+
+  // Load user config
+  const require = createRequire(import.meta.url);
+
+  let userConfig;
+  try {
+    userConfig = require(configPath);
+  } catch (e) {
+    logger.error(`Failed to load config.js: ${e.message}`);
+    process.exit(1);
+  }
+
+  // Ensure defaults if missing
+  if (!userConfig.usrConf) {
+    userConfig.usrConf = {};
+  }
+  if (!userConfig.usrConf.site_url) {
+    userConfig.usrConf.site_url = "auto";
+  }
+  if (!userConfig.usrConf.site_path) {
+    userConfig.usrConf.site_path = "auto";
+  }
+
+  // Generate Docusaurus Config
+  const docusaurusConfig = createConfig(userConfig, projectRoot);
+
+  // Write temp config file INSIDE .portosaurus
+  const tempConfigPath = path.join(dotPorto, "docusaurus.config.js");
+
+  const configContent = `// Auto-generated by Portosaurus
+module.exports = ${JSON.stringify(docusaurusConfig, null, 2)};`;
+
+  writeFileSync(tempConfigPath, configContent);
+  logger.success("Generated Docusaurus config in .portosaurus.");
+
+  return { dotPorto };
+}
+
+async function runDocusaurus(command, args, dotPorto, projectRoot) {
+  // Detect package manager and find docusaurus binary
+  const { findDocusaurusBin } = await import("../utils/packageManager.js");
+  const docusaurus = findDocusaurusBin(projectRoot || process.cwd());
+
+  logger.info(
+    `Running docusaurus ${command} (via ${docusaurus.packageManager})`,
+  );
+
+  const child = spawn(
+    docusaurus.command,
+    [...docusaurus.args, command, dotPorto, ...args],
+    {
+      stdio: "inherit",
+      cwd: projectRoot,
+      env: { ...process.env, FORCE_COLOR: "true" },
+    },
+  );
+
+  return new Promise((resolve, reject) => {
+    child.on("error", (err) => {
+      logger.error(`Failed to run docusaurus ${command}: ${err.message}`);
+      reject(err);
+    });
+
+    child.on("close", (code) => {
+      if (code === 0) resolve();
+      else {
+        process.exit(code);
+      }
+    });
+  });
+}
+
+// --- INIT COMMAND ---
+
+program
+  .command("init")
+  .description("Initialize a new Portosaurus project")
+  .argument("<project-name>", "Name of the project directory")
+  .option("-ngh, --no-github-pages", "Skip GitHub Pages deployment setup")
+  .option("-ni, --no-install", "Skip dependency installation")
+  .action(async (projectName, options) => {
+    const projectPath = path.resolve(process.cwd(), projectName);
+
+    if (existsSync(projectPath)) {
+      logger.error(`Directory ${projectName} already exists.`);
+      process.exit(1);
+    }
+
+    logger.info(
+      `Creating new Portosaurus project in ${chalk.bold(projectName)}...`,
+    );
+
+    try {
+      // Create project directory
+      mkdirSync(projectPath);
+
+      // Copy template files
+      const templatePath = path.resolve(__dirname, "../template");
+
+      // Check if template exists (it might not be populated yet)
+      if (!existsSync(templatePath)) {
+        logger.warn("Template directory not found. Creating basic structure.");
+
+        // Fallback basic creation if template missing (during dev)
+        mkdirpSync(path.join(projectPath, "blog"));
+        mkdirpSync(path.join(projectPath, "notes"));
+        mkdirpSync(path.join(projectPath, "static"));
+        writeFileSync(
+          path.join(projectPath, "config.js"),
+          "module.exports = { /* TODO */ };",
+        );
+      } else {
+        // Copy all template files
+        const templateFiles = readdirSync(templatePath);
+
+        for (const file of templateFiles) {
+          const srcPath = path.join(templatePath, file);
+          const destPath = path.join(projectPath, file);
+          copySync(srcPath, destPath);
+        }
+      }
+
+      // Create package.json
+      const packageJsonContent = {
+        name: projectName,
+        version: "0.0.1",
+        private: true,
+        scripts: {
+          start: "portosaurus start",
+          build: "portosaurus build",
+        },
+        dependencies: {
+          portosaurus: "latest",
+        },
+      };
+
+      writeFileSync(
+        path.join(projectPath, "package.json"),
+        JSON.stringify(packageJsonContent, null, 2),
+      );
+
+      // Git init
+      try {
+        execSync("git init", { cwd: projectPath, stdio: "ignore" });
+      } catch (e) {
+        logger.warn("Failed to initialize git repository.");
+      }
+
+      // Remove GitHub Pages files if --no-github-pages flag is set
+      if (options.githubPages === false) {
+        const githubDir = path.join(projectPath, ".github");
+        if (existsSync(githubDir)) {
+          removeSync(githubDir);
+          logger.info("Skipped GitHub Pages setup");
+        }
+      } else {
+        // GitHub Pages is enabled by default
+        // Create .nojekyll in static directory
+        const nojekyllPath = path.join(projectPath, "static", ".nojekyll");
+        writeFileSync(nojekyllPath, "");
+
+        logger.success("GitHub Pages deployment configured");
+        logger.tip(
+          "Enable GitHub Pages: Settings > Pages > Source: GitHub Actions",
+        );
+      }
+
+      logger.success(`Success! Created ${projectName} at ${projectPath}`);
+
+      // Detect package manager for install instructions
+      const { detectPackageManager } =
+        await import("../utils/packageManager.js");
+      const pm = detectPackageManager(projectPath) || "npm";
+      const installCmd = pm === "npm" ? "npm install" : `${pm} install`;
+      const runCmd = pm === "npm" ? "npm run" : `${pm} run`;
+
+      if (options.install !== false) {
+        logger.info(`Running ${installCmd}...`);
+        try {
+          execSync(installCmd, {
+            cwd: projectPath,
+            stdio: "inherit",
+          });
+
+          logger.success("Dependencies installed!");
+          logger.tip("You can now run:");
+          logger.info(`  cd ${projectName}`);
+          logger.info(`  ${runCmd} start`);
+        } catch (error) {
+          logger.error("Failed to install dependencies.");
+          logger.tip("You can install them manually:");
+          logger.info(`  cd ${projectName}`);
+          logger.info(`  ${installCmd}`);
+        }
+      } else {
+        logger.tip("Inside that directory, you can run:");
+        logger.info(`  cd ${projectName}`);
+        logger.info(`  ${installCmd}`);
+        logger.info(`  ${runCmd} start`);
+      }
+    } catch (error) {
+      logger.error(`Failed to initialize project: ${error.message}`);
+      process.exit(1);
+    }
+  });
+
+// --- START COMMAND ---
+
+program
+  .command("start")
+  .description("Start the development server")
+  .action(async () => {
+    const projectRoot = process.cwd();
+    logger.info("Starting development server...");
+    try {
+      const { dotPorto } = await prepareDocusaurusRun(projectRoot);
+      await runDocusaurus("start", [], dotPorto, projectRoot);
+    } catch (error) {
+      logger.error(`Failed to start: ${error.message}`);
+      process.exit(1);
+    }
+  });
+
+// --- BUILD COMMAND ---
+
+program
+  .command("build")
+  .description("Build the static site")
+  .action(async () => {
+    const projectRoot = process.cwd();
+    logger.info("Building Portosaurus site...");
+
+    try {
+      const { dotPorto } = await prepareDocusaurusRun(projectRoot);
+
+      const buildDir = path.join(projectRoot, "build");
+      const args = ["--out-dir", buildDir];
+
+      await runDocusaurus("build", args, dotPorto, projectRoot);
+
+      // Create .nojekyll for GitHub Pages compatibility
+      const nojekyllPath = path.join(buildDir, ".nojekyll");
+      if (existsSync(buildDir)) {
+        writeFileSync(nojekyllPath, "");
+        logger.info("Created .nojekyll");
+      }
+
+      logger.success("Build completed successfully!");
+      logger.info(`Output directory: ${buildDir}`);
+    } catch (error) {
+      logger.error(`Failed to build: ${error.message}`);
+      process.exit(1);
+    }
+  });
+
+program.parse();

package/internal/notes/index.md

@@ -0,0 +1,10 @@
+---
+sidebar_position: 0
+id: index
+---
+
+# Notes
+
+Welcome to your notes section! This is your knowledge base.
+
+Browse the sidebar to explore your notes, or start creating new ones.

package/internal/sidebars.js

@@ -0,0 +1,20 @@
+/**
+ * Default sidebars configuration for Portosaurus
+ * This file is auto-generated and copied to user projects
+ */
+
+module.exports = {
+  notes: [
+    {
+      type: "category",
+      label: "Notes",
+      link: { type: "doc", id: "index" },
+      items: [
+        {
+          type: "autogenerated",
+          dirName: ".",
+        },
+      ],
+    },
+  ],
+};

package/internal/src/components/AboutSection/index.js

@@ -0,0 +1,67 @@
+import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
+import styles from './styles.module.css';
+
+export default function AboutSection({ id, className}) {
+  const { siteConfig } = useDocusaurusContext();
+  const { customFields } = siteConfig;
+  const aboutMe = customFields.aboutMe || {};
+
+  return (
+    <div id={id} className={`${styles.aboutSection} ${className || ''}`} role="region" aria-label="About me section">
+      <div className={styles.aboutContainer}>
+        <div className={styles.aboutHeader}>
+          <h2 className={styles.aboutHeading}>{"About Me"}</h2>
+        </div>
+
+        <div className={styles.aboutContent}>
+          <div className={styles.aboutBio}>
+            <div className={styles.bioImageContainer}>
+              {aboutMe.image && (
+                <div className={styles.imageWrapper}>
+                  <img 
+                    src={aboutMe.image} 
+                    alt="About Me" 
+                    className={styles.aboutImage}
+                    loading="lazy"
+                  />
+                </div>
+              )}
+            </div>
+
+            <div className={styles.bioTextContainer}>
+              <div className={styles.bioText}>
+                {Array.isArray(aboutMe.description) ? (
+                  aboutMe.description.map((paragraph, index) => (
+                    <p key={index} className={styles.aboutParagraph}>{paragraph}</p>
+                  ))
+                ) : (
+                  <p className={styles.aboutParagraph}>
+                    {aboutMe.description || "Information about me goes here."}
+                  </p>
+                )}
+              </div>
+              
+              {aboutMe.skills && aboutMe.skills.length > 0 && (
+                <div className={styles.skillsContainer}>
+                  <h3 className={styles.skillsTitle} id="skills-heading">My Skills</h3>
+                  <div className={styles.skillsGrid} role="list">
+                    {aboutMe.skills.map((skill, index) => (
+                      <div 
+                        key={index} 
+                        className={styles.skillBadge} 
+                        role="listitem"
+                        style={{ animationDelay: `${index * 0.05}s` }}
+                      >
+                        {skill}
+                      </div>
+                    ))}
+                  </div>
+                </div>
+              )}
+            </div>
+          </div>
+        </div>
+      </div>
+    </div>
+  );
+}