@portosaur/core 0.6.3 → 0.8.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@portosaur/core",
-  "version": "0.6.3",
+  "version": "0.8.0",
   "description": "The engine of portosaur that translates YAML configuration into Docusaurus structures.",
   "license": "GPL-3.0-only",
   "author": "soymadip",
@@ -27,7 +27,7 @@
   },
   "types": "./src/index.d.ts",
   "dependencies": {
-    "@portosaur/logger": "^0.6.3",
+    "@portosaur/logger": "^0.8.0",
     "favicons": "^7.2.0",
     "js-yaml": "^4.1.1",
     "rehype-katex": "7",

package/src/generators/docusaurusConfig.mjs

@@ -4,6 +4,7 @@ import { createRequire } from "module";
 import { getGitDate } from "../utils/system.mjs";
 import { porto } from "../app.mjs";
 import { resolveVars, getNestedValue } from "../utils/config.mjs";
+import { getPortoDotDir } from "../utils/fs.mjs";
 import {
   resolveSiteUrl,
   resolveBasePath,
@@ -56,33 +57,38 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
   const get = (key, ...fallbacks) =>
     getNestedValue(userConfig, key, ...fallbacks);
 
-  const siteName = get("site.title", "Your Name");
+  const defaultTheme =
+    get("theme.appearance.default_mode", "dark") === "light" ? "light" : "dark";
 
-  // ------- Configuration Setup -------
+  const titleName = get("home_page.hero.title", "Your Name");
+  const siteName = get("site.title", titleName);
+  const siteFavicon = resolveAsset(
+    get("site.favicon", ""),
+    resolveAsset(get("home_page.hero.profile_pic", ""), "img/icon.png"),
+  );
+
+  const siteTagline = get(
+    "home_page.hero.desc",
+    "site.tagline",
+    "Short description about you, your passion, your goals etc.",
+  );
 
   // Collect static directories: local site static/, theme assets/, and portosaur dot-dir.
   const staticDirectories = [
     "static",
     assetsDir,
-    path.join(projectDir, ".docusaurus", "portosaur"),
+    getPortoDotDir(projectDir),
   ].filter((dir) => dir && fs.existsSync(dir));
 
-  const isDarkMode = get("theme.appearance.dark_mode", true);
-  const disableSwitch = get("theme.appearance.disable_switch", false);
+  // ------- Configuration Setup -------
 
   return {
     projectName: siteName,
     title: siteName,
-    tagline: get(
-      "site.tagline",
-      "Short description about you, your passion, your goals etc.",
-    ),
+    tagline: siteTagline,
     url: siteUrl,
     baseUrl: sitePath,
-    favicon: resolveAsset(
-      get("site.favicon", ""),
-      resolveAsset("favicon/favicon.ico", "img/icon.png"),
-    ),
+    favicon: siteFavicon,
     organizationName: siteName,
     onBrokenAnchors: get("site.on_broken_anchors", "throw"),
     onBrokenLinks: get("site.on_broken_links", "throw"),
@@ -90,10 +96,20 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
 
     staticDirectories,
 
+    headTags: buildHeadTags([
+      ...(context.extraHeadTags || []),
+      ...get("site.head_tags", []),
+    ]),
+
     themeConfig: {
+      image: resolveAsset(get("site.social_card", "")) || undefined,
+      metadata: [
+        { name: "generator", content: `Portosaur v${porto.version}` },
+        { name: "theme-color", content: "var(--ifm-background-color)" },
+      ],
       colorMode: {
-        defaultMode: isDarkMode ? "dark" : "light",
-        disableSwitch,
+        defaultMode: defaultTheme,
+        disableSwitch: !get("theme.appearance.show_theme_switch", true),
         respectPrefersColorScheme: false,
       },
 
@@ -101,7 +117,7 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
         title: siteName,
         logo: {
           alt: `${siteName} logo`,
-          src: resolveAsset(get("site.favicon", ""), "img/icon.png"),
+          src: siteFavicon,
         },
         hideOnScroll: get("theme.navigation.hide_navbar_on_scroll", true),
         items: [
@@ -161,14 +177,12 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
               ...(get("tasks.enable", false)
                 ? [{ label: "Tasks", to: "/tasks" }]
                 : []),
-              ...(!get("theme.appearance.disable_branding", false)
+              ...(!get("theme.appearance.disable_project_link", false)
                 ? [
                     {
                       label: `Portosaur v${portoVersion}`,
                       className: "_nav-portosaur-version",
-                      href:
-                        porto?.homepage ||
-                        "https://github.com/soymadip/portosaur",
+                      href: porto?.homepage ?? "#",
                     },
                   ]
                 : []),
@@ -177,53 +191,45 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
         ],
       },
 
-      footer: {
-        style: "dark",
-        copyright: get(
-          "site.footer_text",
-          `© ${new Date().getFullYear()} ${siteName}. Built with Portosaur.`,
-        ),
+      docs: {
+        sidebar: {
+          hideable: get("theme.navigation.collapsable_sidebar", true),
+        },
       },
-    },
 
-    headTags: buildHeadTags([
-      { meta: { name: "generator", content: `Portosaur v${porto.version}` } },
-      { meta: { name: "theme-color", content: "var(--ifm-background-color)" } },
-      ...(context.extraHeadTags || []),
-      ...get("site.head_tags", []),
-    ]),
+      tableOfContents: {
+        minHeadingLevel: 2,
+        maxHeadingLevel: 3,
+      },
+
+      markdown: {
+        mermaid: get("theme.markdown.mermaid", true),
+        emoji: get("theme.markdown.render_emoji_shortcodes", true),
+        on_broken_links: get("theme.markdown.on_broken_links", "throw"),
+        on_broken_images: get("theme.markdown.on_broken_images", "throw"),
+      },
+
+      ...(get("theme.footer.enable", true)
+        ? {
+            footer: {
+              copyright: get(
+                "theme.footer.message",
+                `© ${new Date().getFullYear()} ${titleName}.${
+                  !get("theme.footer.disable_project_link", false)
+                    ? ` | Built with <a href="${porto?.homepage ?? "#"}" target="_blank" rel="noopener noreferrer">Portosaur.</a>`
+                    : ""
+                }`,
+              ),
+            },
+          }
+        : {}),
+    },
 
     // ------- Custom Fields -------
 
     customFields: {
       portoVersion,
 
-      theme: {
-        markdown: {
-          mermaid: get("theme.markdown.mermaid", true),
-          on_broken_links: get("theme.markdown.on_broken_links", "throw"),
-          on_broken_images: get("theme.markdown.on_broken_images", "throw"),
-        },
-
-        navigation: {
-          collapsable_sidebar: get(
-            "theme.navigation.collapsable_sidebar",
-            true,
-          ),
-
-          hide_navbar_on_scroll: get(
-            "theme.navigation.hide_navbar_on_scroll",
-            true,
-          ),
-        },
-
-        appearance: {
-          dark_mode: get("theme.appearance.dark_mode", true),
-          disable_switch: get("theme.appearance.disable_switch", false),
-          disable_branding: get("theme.appearance.disable_branding", false),
-        },
-      },
-
       heroSection: {
         profilePic: resolveAsset(
           get("home_page.hero.profile_pic", ""),
@@ -231,7 +237,7 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
         ),
 
         intro: get("home_page.hero.intro", "Hello there, I'm"),
-        title: get("home_page.hero.title", "site.title", "Your Name"),
+        title: titleName,
         subtitle: get("home_page.hero.subtitle", "I am a"),
         profession: get("home_page.hero.profession", "Your Profession"),
         desc: get("home_page.hero.desc", "Welcome to my portfolio."),
@@ -301,6 +307,7 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
           docs: {
             routeBasePath: "notes",
             path: "notes",
+            breadcrumbs: get("theme.navigation.breadcrumbs", true),
             sidebarPath: path.resolve(
               portoPaths.theme ?? context.portoRoot ?? "",
               "config/sidebar.jsx",
@@ -313,6 +320,14 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
             showReadingTime: false,
             remarkPlugins: [remarkMath],
             rehypePlugins: [rehypeKatex],
+            feedOptions: {
+              type: get("site.rss.enable", true) ? "all" : null,
+              copyright: get(
+                "site.rss.copyright",
+                `Copyright © ${new Date().getFullYear()} ${siteName}.`,
+              ),
+              description: get("site.rss.desc", siteTagline),
+            },
           },
           theme: {
             customCss: path.resolve(
@@ -331,9 +346,10 @@ export function buildDocuConfig(rawUserConfig, projectDir, context = {}) {
         (() => {
           const require = createRequire(import.meta.url);
           return require.resolve("@easyops-cn/docusaurus-search-local", {
-            paths: [portoPaths.theme ?? context.portoRoot ?? ""],
+            paths: [projectDir, portoPaths.theme ?? context.portoRoot ?? ""],
           });
         })(),
+
         {
           hashed: true,
           indexDocs: true,

package/src/generators/generateFavicons.mjs

@@ -1,5 +1,6 @@
 import fs from "fs";
 import path from "path";
+import { getPortoDotDir } from "../utils/fs.mjs";
 import { favicons } from "favicons";
 import { downloadImage } from "../utils/imageDownloader.mjs";
 import { reshapeImage } from "../utils/imageProcessor.mjs";
@@ -121,7 +122,7 @@ export async function generateFavicons(siteDir, options = {}) {
     }
   }
 
-  const cacheDir = path.join(siteDir, ".docusaurus", "portosaur", "cache");
+  const cacheDir = path.join(getPortoDotDir(siteDir), "cache");
   createDirectoryIfNotExists(cacheDir);
   const reshapedImagePath = path.join(cacheDir, "profile_pic_reshaped.png");
   const tempFiles = [];

package/src/index.mjs

@@ -2,7 +2,7 @@ import fs from "fs";
 import path from "path";
 import yaml from "js-yaml";
 
-export { mirrorSync, loadPkg } from "./utils/fs.mjs";
+export { mirrorSync, loadPkg, getPortoDotDir } from "./utils/fs.mjs";
 
 export {
   deepMerge,

package/src/utils/fs.mjs

@@ -2,6 +2,15 @@ import fs from "fs";
 import path from "path";
 import { text } from "../app.mjs";
 
+/**
+ * Gets the standardized path to the hidden Portosaur data directory.
+ * @param {string} siteDir - The project root directory.
+ * @returns {string} The resolved path.
+ */
+export function getPortoDotDir(siteDir) {
+  return path.join(siteDir, ".docusaurus", ".portosaur");
+}
+
 /**
  * Loads a package.json file from a directory.
  * @param {string} dir - The directory to look in.