docula 0.12.1 → 0.13.0

package/README.md

@@ -13,6 +13,7 @@
 - [Getting Started](#getting-started)
 - [Using Your own Template](#using-your-own-template)
 - [Building Multiple Pages](#building-multiple-pages)
+- [Using a Github Token](#using-a-github-token)
 - [Helper Functions for Markdown](#helper-functions-for-markdown)
 - [Code of Conduct and Contributing](#code-of-conduct-and-contributing)
 - [License - MIT](#license)
@@ -86,6 +87,10 @@ title: Getting Started
 order: 2
 ```
 
+# Using a Github Token
+
+If you want to use the Github token to access the Github API you can do so by setting the `GITHUB_TOKEN` environment variable. This is useful if you want to access private repositories or if you want to access the Github API without hitting the rate limit. This is optional and you can still use docula without it but could hit rate limits and will not be able to access private repositories.
+
 # Helper Functions for Markdown
 
 docula comes with some helper functions that you can use in your markdown files.

package/dist/docula.js

@@ -1,7 +1,7 @@
 // src/docula.ts
 import http from "http";
 import path3 from "path";
-import process3 from "process";
+import process4 from "process";
 import fs3 from "fs";
 import handler from "serve-handler";
 import updateNotifier from "update-notifier";
@@ -219,6 +219,7 @@ import he from "he";
 import * as cheerio from "cheerio";
 
 // src/github.ts
+import process3 from "process";
 import axios from "axios";
 var Github = class {
   options = {
@@ -240,8 +241,19 @@ var Github = class {
   }
   async getReleases() {
     const url = `${this.options.api}/repos/${this.options.author}/${this.options.repo}/releases`;
+    let config2 = {};
+    if (process3.env.GITHUB_TOKEN) {
+      config2 = {
+        headers: {
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Authorization: `Bearer ${process3.env.GITHUB_TOKEN}`,
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Accept: "application/vnd.github.v3+json"
+        }
+      };
+    }
     try {
-      const result = await axios.get(url);
+      const result = await axios.get(url, config2);
       if (result && result.data.length > 0) {
         return this.addAnchorLink(result.data);
       }
@@ -256,8 +268,19 @@ var Github = class {
   }
   async getContributors() {
     const url = `${this.options.api}/repos/${this.options.author}/${this.options.repo}/contributors`;
+    let config2 = {};
+    if (process3.env.GITHUB_TOKEN) {
+      config2 = {
+        headers: {
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Authorization: `Bearer ${process3.env.GITHUB_TOKEN}`,
+          // eslint-disable-next-line @typescript-eslint/naming-convention
+          Accept: "application/vnd.github.v3+json"
+        }
+      };
+    }
     try {
-      const result = await axios.get(url);
+      const result = await axios.get(url, config2);
       if (result && result.data.length > 0) {
         return result.data;
       }
@@ -606,9 +629,7 @@ var DoculaBuilder = class {
   }
   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;
@@ -634,18 +655,12 @@ var DoculaBuilder = class {
       }
     }
     return {
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
       title: matterData.title,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      navTitle: matterData.navTitle || matterData.title,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      description: matterData.description || "",
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      order: matterData.order || void 0,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      section: matterData.section || void 0,
-      // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
-      keywords: matterData.keywords || [],
+      navTitle: matterData.navTitle ?? matterData.title,
+      description: matterData.description ?? "",
+      order: matterData.order ?? void 0,
+      section: matterData.section ?? void 0,
+      keywords: matterData.keywords ?? [],
       content: documentContent,
       markdown: markdownContent,
       generatedHtml: this._ecto.renderSync(markdownContent, void 0, "markdown"),
@@ -781,7 +796,7 @@ var Docula = class {
    * @returns {void}
    */
   checkForUpdates() {
-    const packageJsonPath = path3.join(process3.cwd(), "package.json");
+    const packageJsonPath = path3.join(process4.cwd(), "package.json");
     if (fs3.existsSync(packageJsonPath)) {
       const packageJson = JSON.parse(fs3.readFileSync(packageJsonPath, "utf8"));
       updateNotifier({ pkg: packageJson }).notify();
@@ -792,9 +807,9 @@ var Docula = class {
    * @param {NodeJS.Process} process
    * @returns {Promise<void>}
    */
-  async execute(process4) {
+  async execute(process5) {
     this.checkForUpdates();
-    const consoleProcess = this._console.parseProcessArgv(process4.argv);
+    const consoleProcess = this._console.parseProcessArgv(process5.argv);
     this.options.singlePage = this.isSinglePageWebsite(this.options.sitePath);
     if (consoleProcess.args.sitePath) {
       this.options.sitePath = consoleProcess.args.sitePath;
@@ -905,15 +920,13 @@ var Docula = class {
     }
     const { port } = options;
     const { outputPath } = options;
-    const config = {
+    const config2 = {
       public: outputPath
     };
-    this._server = http.createServer(
-      async (request, response) => (
-        /* c8 ignore next */
-        handler(request, response, config)
-      )
-    );
+    this._server = http.createServer(async (request, response) => (
+      /* c8 ignore next */
+      handler(request, response, config2)
+    ));
     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.12.1",
+  "version": "0.13.0",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "main": "./dist/docula.js",
@@ -41,38 +41,43 @@
     "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",
-    "prepare": "npm run build"
+    "prepare": "pnpm build"
   },
   "bin": {
     "docula": "./bin/docula.mjs"
   },
   "dependencies": {
-    "axios": "^1.9.0",
-    "cheerio": "^1.0.0",
-    "ecto": "^4.2.3",
-    "feed": "^5.0.1",
+    "axios": "^1.10.0",
+    "cheerio": "^1.1.0",
+    "ecto": "^4.3.0",
+    "feed": "^5.1.0",
     "he": "^1.2.0",
     "serve-handler": "^6.1.6",
     "update-notifier": "^7.3.1",
-    "writr": "^4.4.3"
+    "writr": "^4.4.4"
   },
   "devDependencies": {
-    "@types/express": "^5.0.2",
+    "@types/express": "^5.0.3",
     "@types/he": "^1.2.3",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.15.18",
+    "@types/node": "^24.0.3",
     "@types/serve-handler": "^6.1.4",
     "@types/update-notifier": "^6.0.8",
-    "@vitest/coverage-v8": "^3.1.3",
+    "@vitest/coverage-v8": "^3.2.4",
+    "dotenv": "^16.5.0",
     "rimraf": "^6.0.1",
     "tsup": "^8.5.0",
-    "tsx": "^4.19.4",
+    "tsx": "^4.20.3",
     "typescript": "^5.8.3",
-    "vitest": "^3.1.3",
-    "webpack": "^5.99.8",
-    "xo": "^0.60.0"
+    "vitest": "^3.2.4",
+    "webpack": "^5.99.9",
+    "xo": "^1.1.0"
   },
   "xo": {
+    "rules": {
+      "@typescript-eslint/no-unsafe-call": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off"
+    },
     "ignores": [
       "docula.config.*",
       "vitest.config.*",
@@ -87,7 +92,8 @@
   ],
   "pnpm": {
     "onlyBuiltDependencies": [
-      "esbuild"
+      "esbuild",
+      "unrs-resolver"
     ]
   }
 }