portosaurus 2.0.3 → 2.1.0

package/src/template/.github/workflows/deploy.yml

@@ -0,0 +1,52 @@
+name: Deploy to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - "README.md"
+      - ".gitignore"
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+jobs:
+  deploy:
+    name: Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Cache Bun dependencies
+        uses: actions/cache@v5
+        with:
+          path: ~/.bun/install/cache
+          key: ${{ runner.os }}-bun-${{ hashFiles('**/bun.lockb') }}
+          restore-keys: |
+            ${{ runner.os }}-bun-
+
+      - name: Install dependencies
+        run: bun install --frozen-lockfile
+
+      - name: Build site
+        run: bun run build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: build
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v5

package/src/template/README.md

@@ -0,0 +1,58 @@
+# {{projectName}}
+
+Welcome to my digital personality and portfolio! 👋
+
+This is my personal space on the web to express myself, share my thoughts, and showcase my work to the world.
+
+## About This Repository
+
+This repository contains the source code for my personal website, built with [Portosaurus]({{portoHome}}).
+
+It serves as my:
+
+- **Portfolio**: Highlighting my projects, skills, and professional experience.
+- **Digital Notebook**: A collection of notes, snippets, and ongoing learnings.
+- **Blog**: Long-form articles and deep dives.
+
+## Local Development
+
+If you'd like to explore the code or run this site locally:
+
+1. **Clone the repository:**
+
+   ```bash
+   git clone https://github.com/<MyUserName>/{{projectName}}.git
+   cd {{projectName}}
+   ```
+
+2. **Install dependencies:**
+
+   ```bash
+   bun install
+   ```
+
+   _(npm, yarn, or pnpm work too!)_
+
+3. **Start the development server:**
+
+   ```bash
+   bun run dev
+   ```
+
+4. **Build for production:**
+   ```bash
+   bun run build
+   ```
+
+## Structure
+
+- `config.js` — The configuration for my site.
+- `notes/` — Markdown/MDX files for my digital Notebook.
+- `blog/` — Articles and blog posts.
+- `static/` — Static assets like images and my resume.
+
+---
+
+<br/>
+
+_Powered by [Portosaurus]({{portoHome}})_

package/src/template/blog/authors.yml

@@ -1,4 +1,4 @@
-default:
+you:
   name: Your Name
   title: Author
   url: https://github.com/yourprofile

package/src/template/blog/welcome.md

@@ -1,6 +1,6 @@
 ---
 title: Welcome to the Blog
-authors: [default]
+authors: [you]
 tags: [welcome]
 ---
 

package/src/template/config.js

@@ -1,50 +1,67 @@
+/**
+ * Portosaurus Site Configuration
+ * Defines your digital personality, theme, and layouts.
+ */
 exports.usrConf = {
-
   dark_mode: true,
 
   site_url: "auto",
   site_path: "auto",
+  robots_txt: true,
+  social_card: "@porto/img/social-card.jpeg",
+  collapsable_sidebar: true,
+  hide_navbar_on_scroll: true,
+  disable_theme_switch: false,
+  rss: true,
+
+  cors_proxy: [],
 
   hero_section: {
-    title: "My Portfolio",
+    title: "Your Name",
+    intro: "Hello there, I'm",
+    subtitle: "I am a",
     profession: "Your Profession",
-    description: "Short description about you, your passion, your goals etc.",
-    profile_pic: "img/icon.png",
+    description: "Short description about your profession, passion, goals.",
+    learn_more_button_txt: "Learn More",
+    profile_pic: "@porto/img/icon.png",
   },
 
   about_me: {
     enable: true,
+    image: null, // Falls back to hero_section.profile_pic
     description: [
       "Write about yourself here.",
       "Add as many paragraphs as you want.",
     ],
-    skills: ["Skill 1", "Skill 2", "Skill 3"],
+    skills: ["Skill 1", "Skill 2"],
     resume_link: "",
   },
 
   project_shelf: {
     enable: true,
-    projects: [
-      {
-        title: "My Awesome Project",
-        featured: true,
-        state: "active",
-        desc: "Description of your awesome project.",
-        github: "https://github.com/you/your-project",
-        tags: ["tag1", "tag2"],
-      },
-    ],
+    projects: [],
+  },
+
+  experience: {
+    enable: false,
+    list: [],
   },
 
   social_links: {
     enable: true,
-    links: [
-      {
-        name: "GitHub",
-        icon: "github",
-        desc: "Check out my GitHub",
-        url: "https://github.com/yourprofile",
-      },
-    ],
+    links: [],
+  },
+
+  tasks_page: {
+    enable: false,
+    title: "Tasks",
+    description: "Track your tasks and projects here.",
+    tasks: [],
+  },
+
+  link_shortener: {
+    enable: false,
+    deploy_path: "/l",
+    short_links: {},
   },
 };

package/src/template/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "{{projectName}}",
+  "version": "0.0.1",
+  "private": true,
+  "scripts": {
+    "dev": "portosaurus dev",
+    "start": "portosaurus start",
+    "build": "portosaurus build",
+    "serve": "portosaurus serve"
+  },
+  "dependencies": {
+    "portosaurus": "^{{portoVer}}"
+  },
+  "overrides": {
+    "webpack": "5.105.4"
+  },
+  "resolutions": {
+    "webpack": "5.105.4"
+  }
+}

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

@@ -0,0 +1,2 @@
+<?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

@@ -0,0 +1,2 @@
+<?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/{components → theme/components}/AboutSection/index.js

@@ -1,13 +1,18 @@
-import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
-import styles from './styles.module.css';
+import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
+import styles from "./styles.module.css";
 
-export default function AboutSection({ id, className}) {
+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
+      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>
@@ -18,9 +23,9 @@ export default function AboutSection({ id, className}) {
             <div className={styles.bioImageContainer}>
               {aboutMe.image && (
                 <div className={styles.imageWrapper}>
-                  <img 
-                    src={aboutMe.image} 
-                    alt="About Me" 
+                  <img
+                    src={aboutMe.image}
+                    alt="About Me"
                     className={styles.aboutImage}
                     loading="lazy"
                   />
@@ -32,7 +37,9 @@ export default function AboutSection({ id, className}) {
               <div className={styles.bioText}>
                 {Array.isArray(aboutMe.description) ? (
                   aboutMe.description.map((paragraph, index) => (
-                    <p key={index} className={styles.aboutParagraph}>{paragraph}</p>
+                    <p key={index} className={styles.aboutParagraph}>
+                      {paragraph}
+                    </p>
                   ))
                 ) : (
                   <p className={styles.aboutParagraph}>
@@ -40,15 +47,17 @@ export default function AboutSection({ id, className}) {
                   </p>
                 )}
               </div>
-              
+
               {aboutMe.skills && aboutMe.skills.length > 0 && (
                 <div className={styles.skillsContainer}>
-                  <h3 className={styles.skillsTitle} id="skills-heading">My Skills</h3>
+                  <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} 
+                      <div
+                        key={index}
+                        className={styles.skillBadge}
                         role="listitem"
                         style={{ animationDelay: `${index * 0.05}s` }}
                       >

package/src/{components → theme/components}/AboutSection/styles.module.css

@@ -1,4 +1,3 @@
-
 /* Animations*/
 
 @keyframes skillAppear {
@@ -20,22 +19,25 @@
 }
 
 @keyframes slideUp {
-  from { 
+  from {
     opacity: 0;
-    transform: translateY(20px); 
+    transform: translateY(20px);
   }
-  to { 
+  to {
     opacity: 1;
-    transform: translateY(0); 
+    transform: translateY(0);
   }
 }
 
 @keyframes fadeIn {
-  from { opacity: 0; }
-  to { opacity: 1; }
+  from {
+    opacity: 0;
+  }
+  to {
+    opacity: 1;
+  }
 }
 
-
 /*  Styles */
 
 .aboutSection {
@@ -75,7 +77,7 @@
 }
 
 .aboutHeading::after {
-  content: '';
+  content: "";
   position: absolute;
   width: 30%;
   height: 3px;
@@ -117,14 +119,16 @@
   border-radius: var(--ifm-card-border-radius);
   overflow: hidden;
   box-shadow: 0 10px 20px var(--ifm-shadow-color);
-  transform: none; 
-  transition: transform 0.4s ease, box-shadow 0.4s ease;
+  transform: none;
+  transition:
+    transform 0.4s ease,
+    box-shadow 0.4s ease;
   max-width: 350px;
   margin: auto 0;
 }
 
 .imageWrapper::before {
-  content: '';
+  content: "";
   position: absolute;
   top: 0;
   left: 0;
@@ -184,7 +188,7 @@
 }
 
 .aboutParagraph::before {
-  content: '';
+  content: "";
   position: absolute;
   left: 0;
   top: 0.5rem;
@@ -208,7 +212,9 @@
   color: var(--ifm-background-color);
   background-color: var(--ifm-color-primary);
   border-radius: var(--ifm-global-radius);
-  transition: all 0.3s ease, transform 0.2s ease;
+  transition:
+    all 0.3s ease,
+    transform 0.2s ease;
   border: 2px solid var(--ifm-color-primary);
   position: relative;
   overflow: hidden;
@@ -217,15 +223,15 @@
 }
 
 .resumeButton::before {
-  content: '';
+  content: "";
   position: absolute;
   top: 0;
   left: -100%;
   width: 100%;
   height: 100%;
   background: linear-gradient(
-    90deg, 
-    transparent, 
+    90deg,
+    transparent,
     rgba(255, 255, 255, 0.2),
     transparent
   );
@@ -269,7 +275,7 @@
 }
 
 .skillsTitle::after {
-  content: '';
+  content: "";
   position: absolute;
   width: 40%;
   height: 2px;
@@ -325,60 +331,60 @@
     scroll-margin-top: var(--ifm-scroll-margin-top-mobile);
     padding: 1.5rem 0 4rem;
   }
-  
+
   .aboutContainer {
     padding: 0 1.5rem;
   }
-  
+
   .aboutHeader {
     margin-bottom: 2rem;
   }
-  
+
   .aboutHeading {
     font-size: 2.4rem;
   }
-  
+
   .aboutBio {
     flex-direction: column;
     gap: 2rem;
   }
-  
+
   .bioImageContainer {
     width: 100%;
     padding-top: 0;
     padding-bottom: 0.8rem;
     margin-bottom: 0.8rem;
   }
-  
+
   .imageWrapper {
     transform: none;
     max-width: 300px;
     margin: 0 auto;
   }
-  
+
   .bioTextContainer {
     width: 100%;
     gap: 1rem;
   }
-  
+
   .skillsContainer {
     padding: 0.6rem 0 0.5rem;
     margin-top: 0;
   }
-  
+
   .skillsTitle {
     margin-bottom: 1rem;
     display: block;
     text-align: center;
     width: 100%;
   }
-  
+
   .skillsTitle::after {
     width: 40px;
     left: 50%;
     transform: translateX(-50%);
   }
-  
+
   .skillsGrid {
     justify-content: center;
   }
@@ -390,70 +396,70 @@
     padding: 0.5rem 0 2.5rem;
     min-height: auto;
   }
-  
+
   .aboutContainer {
     padding: 0 1rem;
   }
-  
+
   .aboutHeader {
     margin-bottom: 1.4rem;
   }
-  
+
   .aboutHeading {
     font-size: 1.8rem;
   }
-  
+
   .aboutContent {
     gap: 1.5rem;
   }
-  
+
   .aboutBio {
     gap: 1.6rem;
   }
-  
+
   .bioImageContainer {
     padding-top: 0;
     padding-bottom: 0.3rem;
     margin-bottom: 0;
   }
-  
+
   .imageWrapper {
     max-width: 200px;
     margin: 0 auto 0.5rem;
   }
-  
+
   .aboutParagraph {
     font-size: 0.95rem;
     line-height: 1.6;
     padding-left: 0.6rem;
   }
-  
+
   .aboutParagraph::before {
     width: 2px;
   }
-  
+
   .skillsTitle {
     font-size: 1.1rem;
     margin-bottom: 0.8rem;
     text-align: center;
   }
-  
+
   .skillsGrid {
     gap: 0.6rem;
     justify-content: center;
     padding-top: 0.3rem;
   }
-  
+
   .skillBadge {
     font-size: 0.8rem;
     padding: 0.35rem 0.8rem;
     border-radius: 16px;
   }
-  
+
   .bioTextContainer {
     gap: 0.6rem;
   }
-  
+
   .skillsContainer {
     padding: 0.3rem 0 0.5rem;
   }
@@ -463,16 +469,16 @@
   .aboutHeading {
     font-size: 1.6rem;
   }
-  
+
   .imageWrapper {
     max-width: 180px;
   }
-  
+
   .skillBadge {
     font-size: 0.75rem;
     padding: 0.3rem 0.7rem;
   }
-  
+
   .aboutParagraph {
     font-size: 0.9rem;
     line-height: 1.5;
@@ -480,8 +486,13 @@
 }
 
 @media (prefers-reduced-motion: reduce) {
-  .aboutHeading, .aboutContent, .aboutImage, 
-  .resumeButton, .skillBadge, .imageWrapper, .resumeButton::before,
+  .aboutHeading,
+  .aboutContent,
+  .aboutImage,
+  .resumeButton,
+  .skillBadge,
+  .imageWrapper,
+  .resumeButton::before,
   .aboutParagraph {
     animation: none !important;
     transition: none !important;