docula 0.13.0 → 0.20.0

package/dist/docula.js

@@ -1,100 +1,21 @@
 // src/docula.ts
+import fs3 from "fs";
 import http from "http";
 import path3 from "path";
 import process4 from "process";
-import fs3 from "fs";
 import handler from "serve-handler";
 import updateNotifier from "update-notifier";
 
-// src/options.ts
-import path from "path";
-import process from "process";
-var DoculaOptions = class {
-  /**
-   * Path to the template directory
-   */
-  templatePath = path.join(import.meta.url, "../../template").replace("file:", "");
-  /**
-   * Path to the output directory
-   */
-  outputPath = path.join(process.cwd(), "./dist");
-  /**
-   * Path to the site directory
-   */
-  sitePath = path.join(process.cwd(), "./site");
-  /**
-   * Path to the github repository
-   */
-  githubPath = "jaredwray/docula";
-  /**
-   * Site title
-   */
-  siteTitle = "docula";
-  /**
-   * Site description
-   */
-  siteDescription = "Beautiful Website for Your Projects";
-  /**
-   * Site URL
-   */
-  siteUrl = "https://docula.org";
-  /**
-   * Port to run the server
-   */
-  port = 3e3;
-  /**
-   * Single page website
-   */
-  singlePage = true;
-  /**
-   * Sections
-   */
-  sections;
-  constructor(options) {
-    if (options) {
-      this.parseOptions(options);
-    }
-  }
-  parseOptions(options) {
-    if (options.templatePath) {
-      this.templatePath = options.templatePath;
-      this.templatePath = path.join(process.cwd(), this.templatePath);
-    }
-    if (options.outputPath) {
-      this.outputPath = options.outputPath;
-      this.githubPath = path.join(process.cwd(), this.outputPath);
-    }
-    if (options.sitePath) {
-      this.sitePath = options.sitePath;
-      this.sitePath = path.join(process.cwd(), this.sitePath);
-    }
-    if (options.githubPath) {
-      this.githubPath = options.githubPath;
-    }
-    if (options.siteTitle) {
-      this.siteTitle = options.siteTitle;
-    }
-    if (options.siteDescription) {
-      this.siteDescription = options.siteDescription;
-    }
-    if (options.siteUrl) {
-      this.siteUrl = options.siteUrl;
-    }
-    if (options.sections) {
-      this.sections = options.sections;
-    }
-    if (options.port) {
-      this.port = options.port;
-    }
-    if (options.singlePage !== void 0 && typeof options.singlePage === "boolean") {
-      this.singlePage = options.singlePage;
-    }
-  }
-};
+// src/builder.ts
+import fs from "fs";
+import * as cheerio from "cheerio";
+import { Ecto } from "ecto";
+import he from "he";
+import { Writr } from "writr";
 
 // src/console.ts
-import path2 from "path";
-import process2 from "process";
+import path from "path";
+import process from "process";
 var DoculaConsole = class {
   log(message) {
     console.log(message);
@@ -110,21 +31,29 @@ var DoculaConsole = class {
     console.log();
     console.log("   Commands:");
     console.log("     init           Initialize a new project");
-    console.log("     build          Build the project. By default just npx docula will build the project if it finds a ./site folder");
+    console.log(
+      "     build          Build the project. By default just npx docula will build the project if it finds a ./site folder"
+    );
     console.log("     serve          Serve the project as a local website");
     console.log("     help           Print this help");
     console.log("     version        Print the version");
     console.log();
     console.log("   Arguments Build:");
     console.log("     -w, --watch            watch for changes and rebuild");
-    console.log("     -s, --site             Set the path where site files are located");
-    console.log("     -o, --outputPath       Set the output directory. Default is ./site/dist");
+    console.log(
+      "     -s, --site             Set the path where site files are located"
+    );
+    console.log(
+      "     -o, --outputPath       Set the output directory. Default is ./site/dist"
+    );
     console.log("     -t, --templatePath     Set the custom template to use");
     console.log();
     console.log("   Arguments serve:");
     console.log("     -p, --port         Set the port number used with serve");
     console.log("     -w, --watch        watch for changes and rebuild");
-    console.log("     -s, --site         Set the path where site files are located");
+    console.log(
+      "     -s, --site         Set the path where site files are located"
+    );
   }
   parseProcessArgv(argv) {
     const command = this.getCommand(argv);
@@ -136,32 +65,25 @@ var DoculaConsole = class {
     };
   }
   getCommand(argv) {
-    let result;
     for (const argument of argv) {
       switch (argument) {
         case "init": {
-          result = "init";
-          break;
+          return "init";
         }
         case "build": {
-          result = "build";
-          break;
+          return "build";
         }
         case "serve": {
-          result = "serve";
-          break;
+          return "serve";
         }
         case "help": {
-          result = "help";
-          break;
+          return "help";
         }
         case "version": {
-          result = argument;
-          break;
+          return "version";
         }
       }
     }
-    return result;
   }
   getArguments(argv) {
     const arguments_ = {
@@ -185,7 +107,7 @@ var DoculaConsole = class {
         case "-o":
         case "--output": {
           arguments_.output = argv[i + 1];
-          arguments_.output = path2.join(process2.cwd(), arguments_.output);
+          arguments_.output = path.join(process.cwd(), arguments_.output);
           break;
         }
         case "-w":
@@ -196,13 +118,16 @@ var DoculaConsole = class {
         case "-s":
         case "--site": {
           arguments_.sitePath = argv[i + 1];
-          arguments_.sitePath = path2.join(process2.cwd(), arguments_.sitePath);
+          arguments_.sitePath = path.join(process.cwd(), arguments_.sitePath);
           break;
         }
         case "-t":
         case "--templatePath": {
           arguments_.templatePath = argv[i + 1];
-          arguments_.templatePath = path2.join(process2.cwd(), arguments_.templatePath);
+          arguments_.templatePath = path.join(
+            process.cwd(),
+            arguments_.templatePath
+          );
           break;
         }
       }
@@ -211,15 +136,8 @@ var DoculaConsole = class {
   }
 };
 
-// src/builder.ts
-import fs from "fs";
-import { Ecto } from "ecto";
-import { Writr } from "writr";
-import he from "he";
-import * as cheerio from "cheerio";
-
 // src/github.ts
-import process3 from "process";
+import process2 from "process";
 import axios from "axios";
 var Github = class {
   options = {
@@ -239,21 +157,20 @@ var Github = class {
     data.contributors = await this.getContributors();
     return data;
   }
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   async getReleases() {
     const url = `${this.options.api}/repos/${this.options.author}/${this.options.repo}/releases`;
-    let config2 = {};
-    if (process3.env.GITHUB_TOKEN) {
-      config2 = {
+    let config = {};
+    if (process2.env.GITHUB_TOKEN) {
+      config = {
         headers: {
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          Authorization: `Bearer ${process3.env.GITHUB_TOKEN}`,
-          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Authorization: `Bearer ${process2.env.GITHUB_TOKEN}`,
           Accept: "application/vnd.github.v3+json"
         }
       };
     }
     try {
-      const result = await axios.get(url, config2);
+      const result = await axios.get(url, config);
       if (result && result.data.length > 0) {
         return this.addAnchorLink(result.data);
       }
@@ -261,33 +178,36 @@ var Github = class {
     } catch (error) {
       const typedError = error;
       if (typedError.response?.status === 404) {
-        throw new Error(`Repository ${this.options.author}/${this.options.repo} not found.`);
+        throw new Error(
+          `Repository ${this.options.author}/${this.options.repo} not found.`
+        );
       }
       throw error;
     }
   }
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   async getContributors() {
     const url = `${this.options.api}/repos/${this.options.author}/${this.options.repo}/contributors`;
-    let config2 = {};
-    if (process3.env.GITHUB_TOKEN) {
-      config2 = {
+    let config = {};
+    if (process2.env.GITHUB_TOKEN) {
+      config = {
         headers: {
-          // eslint-disable-next-line @typescript-eslint/naming-convention
-          Authorization: `Bearer ${process3.env.GITHUB_TOKEN}`,
-          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Authorization: `Bearer ${process2.env.GITHUB_TOKEN}`,
           Accept: "application/vnd.github.v3+json"
         }
       };
     }
     try {
-      const result = await axios.get(url, config2);
+      const result = await axios.get(url, config);
       if (result && result.data.length > 0) {
         return result.data;
       }
     } catch (error) {
       const typedError = error;
       if (typedError.response?.status === 404) {
-        throw new Error(`Repository ${this.options.author}/${this.options.repo} not found.`);
+        throw new Error(
+          `Repository ${this.options.author}/${this.options.repo} not found.`
+        );
       }
       throw error;
     }
@@ -299,6 +219,7 @@ var Github = class {
     this.options.author = options.author;
     this.options.repo = options.repo;
   }
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   addAnchorLink(data) {
     return data.map((release) => {
       const regex = /(?<!]\()(https:\/\/[\w./]+)(?!\))/g;
@@ -308,11 +229,99 @@ var Github = class {
   }
 };
 
+// src/options.ts
+import path2 from "path";
+import process3 from "process";
+var DoculaOptions = class {
+  /**
+   * Path to the template directory
+   */
+  templatePath = path2.join(import.meta.url, "../../template").replace("file:", "");
+  /**
+   * Path to the output directory
+   */
+  outputPath = path2.join(process3.cwd(), "./dist");
+  /**
+   * Path to the site directory
+   */
+  sitePath = path2.join(process3.cwd(), "./site");
+  /**
+   * Path to the github repository
+   */
+  githubPath = "jaredwray/docula";
+  /**
+   * Site title
+   */
+  siteTitle = "docula";
+  /**
+   * Site description
+   */
+  siteDescription = "Beautiful Website for Your Projects";
+  /**
+   * Site URL
+   */
+  siteUrl = "https://docula.org";
+  /**
+   * Port to run the server
+   */
+  port = 3e3;
+  /**
+   * Single page website
+   */
+  singlePage = true;
+  /**
+   * Sections
+   */
+  sections;
+  constructor(options) {
+    if (options) {
+      this.parseOptions(options);
+    }
+  }
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
+  parseOptions(options) {
+    if (options.templatePath) {
+      this.templatePath = options.templatePath;
+      this.templatePath = path2.join(process3.cwd(), this.templatePath);
+    }
+    if (options.outputPath) {
+      this.outputPath = options.outputPath;
+      this.githubPath = path2.join(process3.cwd(), this.outputPath);
+    }
+    if (options.sitePath) {
+      this.sitePath = options.sitePath;
+      this.sitePath = path2.join(process3.cwd(), this.sitePath);
+    }
+    if (options.githubPath) {
+      this.githubPath = options.githubPath;
+    }
+    if (options.siteTitle) {
+      this.siteTitle = options.siteTitle;
+    }
+    if (options.siteDescription) {
+      this.siteDescription = options.siteDescription;
+    }
+    if (options.siteUrl) {
+      this.siteUrl = options.siteUrl;
+    }
+    if (options.sections) {
+      this.sections = options.sections;
+    }
+    if (options.port) {
+      this.port = options.port;
+    }
+    if (options.singlePage !== void 0 && typeof options.singlePage === "boolean") {
+      this.singlePage = options.singlePage;
+    }
+  }
+};
+
 // src/builder.ts
 var DoculaBuilder = class {
   _options = new DoculaOptions();
   _ecto;
   _console = new DoculaConsole();
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   constructor(options, engineOptions) {
     if (options) {
       this._options = options;
@@ -336,10 +345,19 @@ var DoculaBuilder = class {
       sections: this.options.sections
     };
     doculaData.github = await this.getGithubData(this.options.githubPath);
-    doculaData.documents = this.getDocuments(`${doculaData.sitePath}/docs`, doculaData);
-    doculaData.sections = this.getSections(`${doculaData.sitePath}/docs`, this.options);
+    doculaData.documents = this.getDocuments(
+      `${doculaData.sitePath}/docs`,
+      doculaData
+    );
+    doculaData.sections = this.getSections(
+      `${doculaData.sitePath}/docs`,
+      this.options
+    );
     doculaData.hasDocuments = doculaData.documents?.length > 0;
-    doculaData.templates = await this.getTemplates(this.options, doculaData.hasDocuments);
+    doculaData.templates = await this.getTemplates(
+      this.options,
+      doculaData.hasDocuments
+    );
     await this.buildIndexPage(doculaData);
     await this.buildReleasePage(doculaData);
     await this.buildSiteMapPage(doculaData);
@@ -422,10 +440,7 @@ var DoculaBuilder = class {
       if (releases) {
         templates.releases = releases;
       }
-      const documentPage = hasDocuments ? await this.getTemplateFile(
-        options.templatePath,
-        "docs"
-      ) : void 0;
+      const documentPage = hasDocuments ? await this.getTemplateFile(options.templatePath, "docs") : void 0;
       if (documentPage) {
         templates.docPage = documentPage;
       }
@@ -516,7 +531,11 @@ var DoculaBuilder = class {
         `${data.sitePath}/README.md`,
         "utf8"
       );
-      htmlReadme = await this._ecto.render(readmeContent, void 0, "markdown");
+      htmlReadme = await this._ecto.render(
+        readmeContent,
+        void 0,
+        "markdown"
+      );
     }
     return htmlReadme;
   }
@@ -527,7 +546,9 @@ var DoculaBuilder = class {
       data.sidebarItems = this.generateSidebarItems(data);
       const promises = data.documents.map(async (document) => {
         const folder = document.urlPath.split("/").slice(0, -1).join("/");
-        await fs.promises.mkdir(`${data.outputPath}/${folder}`, { recursive: true });
+        await fs.promises.mkdir(`${data.outputPath}/${folder}`, {
+          recursive: true
+        });
         const slug = `${data.outputPath}${document.urlPath}`;
         let documentContent = await this._ecto.renderFromFile(
           documentsTemplate,
@@ -552,10 +573,18 @@ var DoculaBuilder = class {
           order: document.order
         });
       } else {
-        const relativeFilePath = document.documentPath.replace(`${data.sitePath}/docs/`, "");
-        const sectionPath = relativeFilePath.slice(0, Math.max(0, relativeFilePath.lastIndexOf("/")));
+        const relativeFilePath = document.documentPath.replace(
+          `${data.sitePath}/docs/`,
+          ""
+        );
+        const sectionPath = relativeFilePath.slice(
+          0,
+          Math.max(0, relativeFilePath.lastIndexOf("/"))
+        );
         const documentSection = document.section ?? sectionPath;
-        const sectionIndex = sidebarItems.findIndex((section) => section.path === documentSection);
+        const sectionIndex = sidebarItems.findIndex(
+          (section) => section.path === documentSection
+        );
         if (sectionIndex === -1) {
           continue;
         }
@@ -569,15 +598,23 @@ var DoculaBuilder = class {
     }
     sidebarItems = sidebarItems.map((section) => {
       if (section.children) {
-        section.children.sort((a, b) => (a.order ?? section.children.length) - (b.order ?? section.children.length));
+        section.children.sort(
+          (a, b) => (
+            // biome-ignore lint/style/noNonNullAssertion: need to fix
+            (a.order ?? section.children.length) - // biome-ignore lint/style/noNonNullAssertion: need to fix
+            (b.order ?? section.children.length)
+          )
+        );
       }
       return section;
     });
-    sidebarItems.sort((a, b) => (a.order ?? sidebarItems.length) - (b.order ?? sidebarItems.length));
+    sidebarItems.sort(
+      (a, b) => (a.order ?? sidebarItems.length) - (b.order ?? sidebarItems.length)
+    );
     return sidebarItems;
   }
   getDocuments(sitePath, doculaData) {
-    let documents = new Array();
+    let documents = [];
     if (fs.existsSync(sitePath)) {
       documents = this.getDocumentInDirectory(sitePath);
       doculaData.sections = this.getSections(sitePath, this.options);
@@ -590,7 +627,7 @@ var DoculaBuilder = class {
     return documents;
   }
   getDocumentInDirectory(sitePath) {
-    const documents = new Array();
+    const documents = [];
     const documentList = fs.readdirSync(sitePath);
     if (documentList.length > 0) {
       for (const document of documentList) {
@@ -602,11 +639,13 @@ var DoculaBuilder = class {
         }
       }
     }
-    documents.sort((a, b) => (a.order ?? documents.length) - (b.order ?? documents.length));
+    documents.sort(
+      (a, b) => (a.order ?? documents.length) - (b.order ?? documents.length)
+    );
     return documents;
   }
   getSections(sitePath, doculaOptions) {
-    const sections = new Array();
+    const sections = [];
     if (fs.existsSync(sitePath)) {
       const documentList = fs.readdirSync(sitePath);
       if (documentList.length > 0) {
@@ -623,13 +662,17 @@ var DoculaBuilder = class {
           }
         }
       }
-      sections.sort((a, b) => (a.order ?? sections.length) - (b.order ?? sections.length));
+      sections.sort(
+        (a, b) => (a.order ?? sections.length) - (b.order ?? sections.length)
+      );
     }
     return sections;
   }
   mergeSectionWithOptions(section, options) {
     if (options.sections) {
-      const sectionOptions = options.sections.find((sectionOption) => sectionOption.path === section.path);
+      const sectionOptions = options.sections.find(
+        (sectionOption) => sectionOption.path === section.path
+      );
       if (sectionOptions) {
         section.name = sectionOptions.name;
         section.order = sectionOptions.order;
@@ -663,7 +706,11 @@ var DoculaBuilder = class {
       keywords: matterData.keywords ?? [],
       content: documentContent,
       markdown: markdownContent,
-      generatedHtml: this._ecto.renderSync(markdownContent, void 0, "markdown"),
+      generatedHtml: this._ecto.renderSync(
+        markdownContent,
+        void 0,
+        "markdown"
+      ),
       tableOfContents: this.getTableOfContents(markdownContent),
       documentPath,
       urlPath,
@@ -750,6 +797,7 @@ var DoculaHelpers = class {
 var Docula = class {
   _options = new DoculaOptions();
   _console = new DoculaConsole();
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   _configFileModule = {};
   _server;
   /**
@@ -788,6 +836,7 @@ var Docula = class {
    * The config file module. This is the module that is loaded from the docula.config.mjs file
    * @returns {any}
    */
+  // biome-ignore lint/suspicious/noExplicitAny: need to fix
   get configFileModule() {
     return this._configFileModule;
   }
@@ -816,7 +865,10 @@ var Docula = class {
     }
     await this.loadConfigFile(this.options.sitePath);
     if (this._configFileModule.options) {
-      this.options.parseOptions(this._configFileModule.options);
+      this.options.parseOptions(
+        // biome-ignore lint/suspicious/noExplicitAny: need to fix
+        this._configFileModule.options
+      );
     }
     if (this._configFileModule.onPrepare) {
       try {
@@ -885,7 +937,9 @@ var Docula = class {
     fs3.writeFileSync(`${sitePath}/favicon.ico`, faviconBuffer);
     const variablesBuffer = Buffer.from(variablescss, "base64");
     fs3.writeFileSync(`${sitePath}/variables.css`, variablesBuffer);
-    this._console.log(`docula initialized. Please update the ${doculaConfigFile} file with your site information. In addition, you can replace the image, favicon, and stype the site with site.css file.`);
+    this._console.log(
+      `docula initialized. Please update the ${doculaConfigFile} file with your site information. In addition, you can replace the image, favicon, and style the site with site.css file.`
+    );
   }
   /**
    * Get the version of the package
@@ -920,13 +974,15 @@ var Docula = class {
     }
     const { port } = options;
     const { outputPath } = options;
-    const config2 = {
+    const config = {
       public: outputPath
     };
-    this._server = http.createServer(async (request, response) => (
-      /* c8 ignore next */
-      handler(request, response, config2)
-    ));
+    this._server = http.createServer(
+      async (request, response) => (
+        /* c8 ignore next */
+        handler(request, response, config)
+      )
+    );
     this._server.listen(port, () => {
       this._console.log(`Docula \u{1F987} at http://localhost:${port}`);
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docula",
-  "version": "0.13.0",
+  "version": "0.20.0",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "main": "./dist/docula.js",
@@ -36,42 +36,44 @@
   "scripts": {
     "clean": "rimraf ./dist ./coverage ./node_modules ./package-lock.json ./yarn.lock ./pnpm-lock.yaml ./site/README.md ./site/dist",
     "build": "pnpm generate-init-file && rimraf ./dist && tsup src/docula.ts --format esm --dts --clean",
-    "serve-mega": "rimraf ./test/fixtures/mega-page-site/dist && node bin/docula.mjs serve -s ./test/fixtures/mega-page-site",
-    "test": "xo --fix && vitest run --coverage",
+    "lint": "biome check --write",
+    "test": "pnpm lint && vitest run --coverage",
+    "test:ci": "biome check && vitest run --coverage",
     "generate-init-file": "tsx scripts/generate-init-file.ts",
     "website:build": "rimraf ./site/README.md && node bin/docula.mjs build -s ./site -o ./site/dist",
     "website:serve": "rimraf ./site/README.md && node bin/docula.mjs serve -s ./site -o ./site/dist",
+    "website:serve:mega": "rimraf ./test/fixtures/mega-page-site/dist && node bin/docula.mjs serve -s ./test/fixtures/mega-page-site",
     "prepare": "pnpm build"
   },
   "bin": {
     "docula": "./bin/docula.mjs"
   },
   "dependencies": {
-    "axios": "^1.10.0",
-    "cheerio": "^1.1.0",
-    "ecto": "^4.3.0",
+    "axios": "^1.11.0",
+    "cheerio": "^1.1.2",
+    "ecto": "^4.4.0",
     "feed": "^5.1.0",
     "he": "^1.2.0",
     "serve-handler": "^6.1.6",
     "update-notifier": "^7.3.1",
-    "writr": "^4.4.4"
+    "writr": "^4.4.6"
   },
   "devDependencies": {
+    "@biomejs/biome": "^2.2.0",
     "@types/express": "^5.0.3",
     "@types/he": "^1.2.3",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^24.0.3",
+    "@types/node": "^24.3.0",
     "@types/serve-handler": "^6.1.4",
     "@types/update-notifier": "^6.0.8",
     "@vitest/coverage-v8": "^3.2.4",
-    "dotenv": "^16.5.0",
+    "dotenv": "^17.2.1",
     "rimraf": "^6.0.1",
     "tsup": "^8.5.0",
-    "tsx": "^4.20.3",
-    "typescript": "^5.8.3",
+    "tsx": "^4.20.4",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.4",
-    "webpack": "^5.99.9",
-    "xo": "^1.1.0"
+    "webpack": "^5.101.3"
   },
   "xo": {
     "rules": {

package/template/css/landing.css

@@ -0,0 +1,36 @@
+/* Landing */
+.home-hero {
+  display: flex;
+  justify-content: center;
+  height: 20vh;
+  padding: 3rem 0 2.5rem;
+}
+
+@media screen and (min-width: 768px) {
+  .home-hero {
+    height: 40vh;
+  }
+}
+
+.hero-container {
+  margin: 2rem auto 3rem;
+  max-width: 90%;
+}
+
+.home-container {
+  margin: 0 auto 3rem;
+}
+
+.home-container h1,
+.hero-container h1 {
+  font-weight: 500;
+  font-size: 1.5rem;
+}
+
+.home-docs-button {
+  padding: 0.75rem 1.5rem;
+  border: 2px solid var(--color-secondary-dark);
+  border-radius: 0.5rem;
+  color: var(--color-secondary-dark);
+  font-weight: 600;
+}