portosaurus 0.14.0 → 0.16.0

package/README.md

@@ -1,57 +1,48 @@
-<div align="center">
-    <img src="./static/img/icon.png" width=150>
-    <h1>Postosaurus</h1>
-    <p>Complete portfolio cum personal website solution for your digital personality.</p>
-</div>
+# Portosaurus
 
-<br/>
+> COMPLETE portfolio cum personal website solution for your digital personality.
 
-## 📁 Project Structure
+Portosaurus is a Docusaurus-based portfolio generator. It allows you to create a beautiful, developer-focused portfolio with a blog and notes section in minutes, using a simple configuration file.
 
-As this project is built upon docusaurus, it follows it's guidelines.
+## Features
 
-```
-./
-├── blog/
-│   ├── ...
-│   └── My mindset 
-├── notes/
-│   ├── ...
-│   ├── sidebars.js
-│   └── Self written notes, accessiable in /notes
-├── src/
-│   ├── components/
-│   ├── css/
-│   ├── pages/
-│   │   ├─ ...
-│   │   ├── index.js - entry point
-│   │   └── holds standalone pages
-│   └── ...
-├── static/
-│   ├── img/
-│   ├── ...
-│   └── static files
-├── config.js
-├── docusaurus.config.js
-└── package.json
+- **Zero Config Setup**: Scaffolds a complete project with one command.
+- **Config Driven**: Customize everything via `config.ts` or `config.js`.
+- **Blog & Notes**: Built-in support for technical blogging and taking notes.
+- **Themes**: Dark mode support and customizable themes.
+- **Fast**: Built on Docusaurus/React.
+
+## Quick Start
+
+Create a new project:
+
+```bash
+npx portosaurus init my-portfolio
+cd my-portfolio
+npm start
 ```
 
-## 💻 Development
+This will start a local development server at `http://localhost:3000`.
 
-- Run the local development server:
+## Commands
 
-    ```bash
-    npm run start
-    ```
+- `npm start`: Start the development server (aliased to `portosaurus start`).
+- `npm run build`: Build the static site for production (aliased to `portosaurus build`).
+- `npm run serve`: Serve the built site locally (aliased to `portosaurus serve`).
 
-- Build the website:
+## Project Structure
 
-    ```bash
-    npm run build
-    ```
+Your project will look like this:
+
+```
+my-portfolio/
+├── config.ts          # Main configuration
+├── blog/              # Your blog posts (MDX)
+├── notes/             # Your notes (MDX)
+├── src/               # Static assets (images, etc.)
+└── package.json       # Dependency management
+```
 
-- Serve the built website locally:
+## Documentation
 
-    ```bash
-    npm run serve
-    ```
+For full documentation, visit [Portosaurus Docs](https://github.com/StartSomethingStudio/portosaurus).

package/bin/cli.ts

@@ -0,0 +1,60 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { createRequire } from 'module';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const cliRequire = createRequire(import.meta.url);
+
+// prefix removed as per previous step logic, just keep the declaration once
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+
+// Resolve package.json path (handles both dev tsx and prod lib execution)
+const devPkgPath = path.resolve(__dirname, '../package.json');
+const prodPkgPath = path.resolve(__dirname, '../../package.json');
+const packageJsonPath = fs.existsSync(devPkgPath) ? devPkgPath : prodPkgPath;
+const packageJson = cliRequire(packageJsonPath);
+
+const program = new Command();
+
+program
+  .name('portosaurus')
+  .description('Complete portfolio cum personal website solution for your digital personality')
+  .version(packageJson.version);
+
+program
+  .command('init')
+  .description('Initialize a new Portosaurus project')
+  .argument('[directory]', 'Directory to initialize in', '.')
+  .action(async (directory) => {
+    const { initCommand } = await import('../src/cli/commands/init.js');
+    await initCommand(directory);
+  });
+
+program
+  .command('start')
+  .description('Start the development server')
+  .action(async () => {
+    const { startCommand } = await import('../src/cli/commands/start.js');
+    await startCommand();
+  });
+
+program
+  .command('build')
+  .description('Build the website for production')
+  .action(async () => {
+    const { buildCommand } = await import('../src/cli/commands/build.js');
+    await buildCommand();
+  });
+
+program
+  .command('serve')
+  .description('Serve the built website')
+  .action(async () => {
+    const { serveCommand } = await import('../src/cli/commands/serve.js');
+    await serveCommand();
+  });
+
+program.parse(process.argv);

package/docusaurus.config.ts

@@ -0,0 +1,221 @@
+import type { Config } from '@docusaurus/types';
+import type * as Preset from '@docusaurus/preset-classic';
+import { loadUserConfig } from './src/cli/utils/config-loader.js';
+import { createRequire } from 'module';
+
+const require = createRequire(import.meta.url);
+
+import generateFaviconPlugin from './src/utils/generateFavicon.js';
+import generateRobotsTxtPlugin from './src/utils/generateRobotsTxt.js';
+import { metaTags } from './src/config/metaTags.js';
+import { catppuccinMocha, catppuccinLatte } from './src/config/prism.js';
+
+// Helper to filter enabled items
+const useEnabled = (items: any[]) => {
+  return items.flatMap(item => {
+    if (item && typeof item === 'object' && 'enable' in item && 'value' in item) {
+      return item.enable === true ? [item.value] : [];
+    }
+    return [item];
+  });
+};
+
+export default async function createConfig(): Promise<Config> {
+  const userConfig = await loadUserConfig();
+
+  if (!userConfig) {
+    throw new Error('Config file not found! Please create config.ts or config.js');
+  }
+
+  // --- Map Portosaurus Config to Docusaurus Config ---
+  
+  const siteConfig: Config = {
+    headTags: metaTags,
+    title: userConfig.hero_section.title,
+    tagline: userConfig.hero_section.description,
+    favicon: 'img/favicon.ico', // TODO: Make dynamic/configurable
+    
+    // Set the production url of your site here
+    url: userConfig.site_url === 'auto' ? 'https://example.com' : userConfig.site_url,
+    baseUrl: userConfig.site_path === 'auto' ? '/' : userConfig.site_path,
+
+    onBrokenLinks: 'throw',
+    onBrokenMarkdownLinks: 'warn',
+
+    i18n: {
+      defaultLocale: 'en',
+      locales: ['en'],
+    },
+
+    presets: [
+      [
+        'classic',
+        {
+          docs: {
+            routeBasePath: 'notes',
+            path: 'notes',
+             sidebarPath: './src/config/sidebar.ts',
+             admonitions: {
+               keywords: ["note", "tip", "info", "warning", "danger", "question"],
+               extendDefaults: true,
+             },
+          },
+          blog: {
+            showReadingTime: true,
+            path: 'blog',
+            routeBasePath: 'blog',
+            feedOptions: userConfig.rss ? {
+                type: 'all',
+                copyright: `Copyright © ${new Date().getFullYear()} ${userConfig.hero_section.title}`,
+              } : undefined,
+            onInlineTags: 'warn',
+            onInlineAuthors: 'warn',
+            onUntruncatedBlogPosts: 'warn',
+          },
+          theme: {
+            customCss: './src/css/custom.css',
+          },
+        } satisfies Preset.Options,
+      ],
+    ],
+
+    plugins: [
+        generateFaviconPlugin as any, // TODO: strict plugin types
+        generateRobotsTxtPlugin as any,
+      [
+        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"],
+        },
+      ],
+       require.resolve('plugin-image-zoom'),
+    ],
+
+    customFields: {
+      version: '1.0.0', // TODO: dynamic
+      heroSection: {
+        profilePic: userConfig.hero_section.profile_pic,
+        intro: "Hi, I am",
+        title: userConfig.hero_section.title,
+        subtitle: "I am a",
+        profession: userConfig.hero_section.profession,
+        description: userConfig.hero_section.description,
+        learnMoreButtonTxt: "Learn More",
+      },
+      aboutMe: userConfig.about_me,
+      projects: userConfig.project_shelf,
+      experience: userConfig.experience,
+      socialLinks: userConfig.social_links,
+      robotsTxt: { enable: userConfig.rebots_txt, rules: [{ disallow: ["/notes/", "/tasks/"] }], customLines: [] },
+      tasksPage: userConfig.tasks_page,
+    },
+
+    themeConfig: {
+      image: userConfig.social_card || "img/social-card.jpeg",
+      docs: {
+        sidebar: {
+          hideable: userConfig.colapsable_sidebar,
+        },
+      },
+      imageZoom: {
+        options: {
+          margin: 2,
+          background: "rgba(var(--ifm-background-color-rgb), 0.9)",
+        },
+      },
+      colorMode: {
+        defaultMode: userConfig.dark_mode ? "dark" : "light",
+        disableSwitch: userConfig.disable_theme_switch,
+      },
+      navbar: {
+        title: userConfig.hero_section.title,
+        hideOnScroll: userConfig.hide_navbar_on_scroll,
+        logo: {
+          alt: 'Site Logo',
+          src: userConfig.hero_section.profile_pic, // Using profile pic as logo per original config
+        },
+        items: useEnabled([
+           {
+            type: "search",
+            position: "right",
+            className: "navbar-search-bar",
+          },
+          {
+            enable: userConfig.about_me?.enable,
+            value: {
+              label: "About Me",
+              to: "/#about",
+              position: "right",
+              activeBaseRegex: "^/#about",
+            },
+          },
+          {
+            enable: userConfig.project_shelf?.enable,
+            value: {
+              label: "Projects",
+              to: "/#projects",
+              position: "right",
+              activeBaseRegex: "^/#projects",
+            },
+          },
+          {
+            enable: userConfig.experience?.enable,
+            value: {
+              label: "Experience",
+              to: "/#experience",
+              position: "right",
+              activeBaseRegex: "^/#experience",
+            },
+          },
+          {
+            enable: userConfig.social_links?.enable,
+            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: true,
+                value: {
+                  label: `Portosaurus`,
+                  className: "_nav-protosaurus-version",
+                  href: "https://github.com/soymadip/portosaurus",
+                },
+              },
+            ]),
+          }
+        ]),
+      },
+      footer: {
+         // Empty footer per original config
+      },
+      // tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 4 }, // Add if needed
+      prism: {
+        theme: catppuccinLatte as any,
+        darkTheme: catppuccinMocha as any,
+        additionalLanguages: ["java", "php", "bash"],
+      },
+    } satisfies Preset.ThemeConfig,
+  };
+
+  return siteConfig;
+}

package/lib/bin/cli.js

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+import { Command } from 'commander';
+import { createRequire } from 'module';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+const cliRequire = createRequire(import.meta.url);
+// prefix removed as per previous step logic, just keep the declaration once
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+// Resolve package.json path (handles both dev tsx and prod lib execution)
+const devPkgPath = path.resolve(__dirname, '../package.json');
+const prodPkgPath = path.resolve(__dirname, '../../package.json');
+const packageJsonPath = fs.existsSync(devPkgPath) ? devPkgPath : prodPkgPath;
+const packageJson = cliRequire(packageJsonPath);
+const program = new Command();
+program
+    .name('portosaurus')
+    .description('Complete portfolio cum personal website solution for your digital personality')
+    .version(packageJson.version);
+program
+    .command('init')
+    .description('Initialize a new Portosaurus project')
+    .argument('[directory]', 'Directory to initialize in', '.')
+    .action(async (directory) => {
+    const { initCommand } = await import('../src/cli/commands/init.js');
+    await initCommand(directory);
+});
+program
+    .command('start')
+    .description('Start the development server')
+    .action(async () => {
+    const { startCommand } = await import('../src/cli/commands/start.js');
+    await startCommand();
+});
+program
+    .command('build')
+    .description('Build the website for production')
+    .action(async () => {
+    const { buildCommand } = await import('../src/cli/commands/build.js');
+    await buildCommand();
+});
+program
+    .command('serve')
+    .description('Serve the built website')
+    .action(async () => {
+    const { serveCommand } = await import('../src/cli/commands/serve.js');
+    await serveCommand();
+});
+program.parse(process.argv);

package/lib/docusaurus.config.js

@@ -0,0 +1,204 @@
+import { loadUserConfig } from './src/cli/utils/config-loader.js';
+import { createRequire } from 'module';
+const require = createRequire(import.meta.url);
+import generateFaviconPlugin from './src/utils/generateFavicon.js';
+import generateRobotsTxtPlugin from './src/utils/generateRobotsTxt.js';
+import { metaTags } from './src/config/metaTags.js';
+import { catppuccinMocha, catppuccinLatte } from './src/config/prism.js';
+// Helper to filter enabled items
+const useEnabled = (items) => {
+    return items.flatMap(item => {
+        if (item && typeof item === 'object' && 'enable' in item && 'value' in item) {
+            return item.enable === true ? [item.value] : [];
+        }
+        return [item];
+    });
+};
+export default async function createConfig() {
+    const userConfig = await loadUserConfig();
+    if (!userConfig) {
+        throw new Error('Config file not found! Please create config.ts or config.js');
+    }
+    // --- Map Portosaurus Config to Docusaurus Config ---
+    const siteConfig = {
+        headTags: metaTags,
+        title: userConfig.hero_section.title,
+        tagline: userConfig.hero_section.description,
+        favicon: 'img/favicon.ico', // TODO: Make dynamic/configurable
+        // Set the production url of your site here
+        url: userConfig.site_url === 'auto' ? 'https://example.com' : userConfig.site_url,
+        baseUrl: userConfig.site_path === 'auto' ? '/' : userConfig.site_path,
+        onBrokenLinks: 'throw',
+        onBrokenMarkdownLinks: 'warn',
+        i18n: {
+            defaultLocale: 'en',
+            locales: ['en'],
+        },
+        presets: [
+            [
+                'classic',
+                {
+                    docs: {
+                        routeBasePath: 'notes',
+                        path: 'notes',
+                        sidebarPath: './src/config/sidebar.ts',
+                        admonitions: {
+                            keywords: ["note", "tip", "info", "warning", "danger", "question"],
+                            extendDefaults: true,
+                        },
+                    },
+                    blog: {
+                        showReadingTime: true,
+                        path: 'blog',
+                        routeBasePath: 'blog',
+                        feedOptions: userConfig.rss ? {
+                            type: 'all',
+                            copyright: `Copyright © ${new Date().getFullYear()} ${userConfig.hero_section.title}`,
+                        } : undefined,
+                        onInlineTags: 'warn',
+                        onInlineAuthors: 'warn',
+                        onUntruncatedBlogPosts: 'warn',
+                    },
+                    theme: {
+                        customCss: './src/css/custom.css',
+                    },
+                },
+            ],
+        ],
+        plugins: [
+            generateFaviconPlugin, // TODO: strict plugin types
+            generateRobotsTxtPlugin,
+            [
+                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"],
+                },
+            ],
+            require.resolve('plugin-image-zoom'),
+        ],
+        customFields: {
+            version: '1.0.0', // TODO: dynamic
+            heroSection: {
+                profilePic: userConfig.hero_section.profile_pic,
+                intro: "Hi, I am",
+                title: userConfig.hero_section.title,
+                subtitle: "I am a",
+                profession: userConfig.hero_section.profession,
+                description: userConfig.hero_section.description,
+                learnMoreButtonTxt: "Learn More",
+            },
+            aboutMe: userConfig.about_me,
+            projects: userConfig.project_shelf,
+            experience: userConfig.experience,
+            socialLinks: userConfig.social_links,
+            robotsTxt: { enable: userConfig.rebots_txt, rules: [{ disallow: ["/notes/", "/tasks/"] }], customLines: [] },
+            tasksPage: userConfig.tasks_page,
+        },
+        themeConfig: {
+            image: userConfig.social_card || "img/social-card.jpeg",
+            docs: {
+                sidebar: {
+                    hideable: userConfig.colapsable_sidebar,
+                },
+            },
+            imageZoom: {
+                options: {
+                    margin: 2,
+                    background: "rgba(var(--ifm-background-color-rgb), 0.9)",
+                },
+            },
+            colorMode: {
+                defaultMode: userConfig.dark_mode ? "dark" : "light",
+                disableSwitch: userConfig.disable_theme_switch,
+            },
+            navbar: {
+                title: userConfig.hero_section.title,
+                hideOnScroll: userConfig.hide_navbar_on_scroll,
+                logo: {
+                    alt: 'Site Logo',
+                    src: userConfig.hero_section.profile_pic, // Using profile pic as logo per original config
+                },
+                items: useEnabled([
+                    {
+                        type: "search",
+                        position: "right",
+                        className: "navbar-search-bar",
+                    },
+                    {
+                        enable: userConfig.about_me?.enable,
+                        value: {
+                            label: "About Me",
+                            to: "/#about",
+                            position: "right",
+                            activeBaseRegex: "^/#about",
+                        },
+                    },
+                    {
+                        enable: userConfig.project_shelf?.enable,
+                        value: {
+                            label: "Projects",
+                            to: "/#projects",
+                            position: "right",
+                            activeBaseRegex: "^/#projects",
+                        },
+                    },
+                    {
+                        enable: userConfig.experience?.enable,
+                        value: {
+                            label: "Experience",
+                            to: "/#experience",
+                            position: "right",
+                            activeBaseRegex: "^/#experience",
+                        },
+                    },
+                    {
+                        enable: userConfig.social_links?.enable,
+                        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: true,
+                                value: {
+                                    label: `Portosaurus`,
+                                    className: "_nav-protosaurus-version",
+                                    href: "https://github.com/soymadip/portosaurus",
+                                },
+                            },
+                        ]),
+                    }
+                ]),
+            },
+            footer: {
+            // Empty footer per original config
+            },
+            // tableOfContents: { minHeadingLevel: 2, maxHeadingLevel: 4 }, // Add if needed
+            prism: {
+                theme: catppuccinLatte,
+                darkTheme: catppuccinMocha,
+                additionalLanguages: ["java", "php", "bash"],
+            },
+        },
+    };
+    return siteConfig;
+}

package/lib/src/cli/commands/build.js

@@ -0,0 +1,26 @@
+import { execSync } from 'child_process';
+import path from 'path';
+import fs from 'fs';
+import { fileURLToPath } from 'url';
+import { createRequire } from 'module';
+import { logger } from '../utils/logger.js';
+const require = createRequire(import.meta.url);
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+export async function buildCommand() {
+    logger.info('Building for production...');
+    // Resolve path to docusaurus command
+    const docusaurusCorePath = path.dirname(require.resolve('@docusaurus/core/package.json'));
+    const docusaurusBin = path.join(docusaurusCorePath, 'bin', 'docusaurus.mjs');
+    const sourceConfigPath = path.resolve(__dirname, '../../../docusaurus.config.ts');
+    const compiledConfigPath = path.resolve(__dirname, '../../../docusaurus.config.js');
+    const configPath = fs.existsSync(sourceConfigPath) ? sourceConfigPath : compiledConfigPath;
+    try {
+        execSync(`node "${docusaurusBin}" build --config "${configPath}"`, {
+            stdio: 'inherit',
+        });
+    }
+    catch (error) {
+        logger.error(`Build failed: ${error}`);
+        process.exit(1);
+    }
+}