docula 0.9.3 → 0.9.5

package/dist/docula.d.ts

@@ -8,15 +8,45 @@ type DoculaSection = {
 };
 
 declare class DoculaOptions {
+    /**
+     * Path to the template directory
+     */
     templatePath: string;
+    /**
+     * Path to the output directory
+     */
     outputPath: string;
+    /**
+     * Path to the site directory
+     */
     sitePath: string;
+    /**
+     * Path to the github repository
+     */
     githubPath: string;
+    /**
+     * Site title
+     */
     siteTitle: string;
+    /**
+     * Site description
+     */
     siteDescription: string;
+    /**
+     * Site URL
+     */
     siteUrl: string;
+    /**
+     * Port to run the server
+     */
     port: number;
+    /**
+     * Single page website
+     */
     singlePage: boolean;
+    /**
+     * Sections
+     */
     sections?: DoculaSection[];
     constructor(options?: Record<string, unknown>);
     parseOptions(options: Record<string, any>): void;
@@ -35,17 +65,72 @@ declare class Docula {
     private readonly _console;
     private _configFileModule;
     private _server;
+    /**
+     * Initialize the Docula class
+     * @param {DoculaOptions} options
+     * @returns {void}
+     * @constructor
+     */
     constructor(options?: DoculaOptions);
+    /**
+     * Get the options
+     * @returns {DoculaOptions}
+     */
     get options(): DoculaOptions;
+    /**
+     * Set the options
+     * @param {DoculaOptions} value
+     */
     set options(value: DoculaOptions);
+    /**
+     * The http server used to serve the site
+     * @returns {http.Server | undefined}
+     */
     get server(): http.Server | undefined;
+    /**
+     * The config file module. This is the module that is loaded from the docula.config.mjs file
+     * @returns {any}
+     */
     get configFileModule(): any;
+    /**
+     * Check for updates
+     * @returns {void}
+     */
     checkForUpdates(): void;
+    /**
+     * Is the execution process that runs the docula command
+     * @param {NodeJS.Process} process
+     * @returns {Promise<void>}
+     */
     execute(process: NodeJS.Process): Promise<void>;
+    /**
+     * Checks if the site is a single page website
+     * @param {string} sitePath
+     * @returns {boolean}
+     */
     isSinglePageWebsite(sitePath: string): boolean;
+    /**
+     * Generate the init files
+     * @param {string} sitePath
+     * @returns {void}
+     */
     generateInit(sitePath: string): void;
+    /**
+     * Get the version of the package
+     * @returns {string}
+     */
     getVersion(): string;
+    /**
+     * Load the config file
+     * @param {string} sitePath
+     * @returns {Promise<void>}
+     */
     loadConfigFile(sitePath: string): Promise<void>;
+    /**
+     * Serve the site based on the options (port and output path)
+     * @param {DoculaOptions} options
+     * @returns {Promise<void>}
+     */
     serve(options: DoculaOptions): Promise<void>;
 }
 

package/dist/docula.js

@@ -9,15 +9,45 @@ import express from "express";
 import path from "node:path";
 import process from "node: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) {
@@ -661,7 +691,7 @@ ${markdown}`;
 
 // src/helpers.ts
 import fs2 from "node:fs";
-import { load as load2, dump } from "js-yaml";
+import { Writr } from "writr";
 var DoculaHelpers = class {
   createDoc(path4, destination, frontMatter, contentFunction) {
     const content = fs2.readFileSync(path4, "utf8");
@@ -672,44 +702,27 @@ var DoculaHelpers = class {
     fs2.writeFileSync(destination, newContent, "utf8");
   }
   getFrontMatterFromFile(path4) {
-    const content = fs2.readFileSync(path4, "utf8");
-    return this.getFrontMatter(content);
+    const writr = new Writr();
+    writr.loadFromFileSync(path4);
+    return writr.frontMatter;
   }
   getFrontMatter(content) {
-    const match = /^---\r?\n([\s\S]+?)\r?\n---/.exec(content);
-    if (match) {
-      const frontMatter = load2(match[1]);
-      return frontMatter;
-    }
-    return {};
+    const writr = new Writr(content);
+    return writr.frontMatter;
   }
   setFrontMatterToFile(path4, frontMatter) {
-    const content = fs2.readFileSync(path4, "utf8");
-    const newContent = this.setFrontMatterInContent(content, frontMatter);
-    fs2.writeFileSync(path4, newContent, "utf8");
+    const writr = new Writr();
+    writr.loadFromFileSync(path4);
+    writr.frontMatter = frontMatter;
+    fs2.writeFileSync(path4, writr.content, "utf8");
   }
   setFrontMatterInContent(content, frontMatter) {
     if (!frontMatter) {
       return content;
     }
-    const match = /^---\r?\n([\s\S]+?)\r?\n---\r?\n([\s\S]*)/.exec(content);
-    if (match) {
-      let oldFrontMatter = load2(match[1]);
-      oldFrontMatter = {
-        ...oldFrontMatter,
-        ...frontMatter
-      };
-      const newYaml2 = dump(oldFrontMatter);
-      const newContent2 = `---
-${newYaml2}---
-${match[2]}`;
-      return newContent2;
-    }
-    const newYaml = dump(frontMatter);
-    const newContent = `---
-${newYaml}---
-${content}`;
-    return newContent;
+    const writr = new Writr(content);
+    writr.frontMatter = frontMatter;
+    return writr.content;
   }
 };
 
@@ -719,23 +732,49 @@ var Docula = class {
   _console = new DoculaConsole();
   _configFileModule = {};
   _server;
+  /**
+   * Initialize the Docula class
+   * @param {DoculaOptions} options
+   * @returns {void}
+   * @constructor
+   */
   constructor(options) {
     if (options) {
       this._options = options;
     }
   }
+  /**
+   * Get the options
+   * @returns {DoculaOptions}
+   */
   get options() {
     return this._options;
   }
+  /**
+   * Set the options
+   * @param {DoculaOptions} value
+   */
   set options(value) {
     this._options = value;
   }
+  /**
+   * The http server used to serve the site
+   * @returns {http.Server | undefined}
+   */
   get server() {
     return this._server;
   }
+  /**
+   * The config file module. This is the module that is loaded from the docula.config.mjs file
+   * @returns {any}
+   */
   get configFileModule() {
     return this._configFileModule;
   }
+  /**
+   * Check for updates
+   * @returns {void}
+   */
   checkForUpdates() {
     const packageJsonPath = path3.join(process3.cwd(), "package.json");
     if (fs3.existsSync(packageJsonPath)) {
@@ -743,6 +782,11 @@ var Docula = class {
       updateNotifier({ pkg: packageJson }).notify();
     }
   }
+  /**
+   * Is the execution process that runs the docula command
+   * @param {NodeJS.Process} process
+   * @returns {Promise<void>}
+   */
   async execute(process4) {
     this.checkForUpdates();
     const consoleProcess = this._console.parseProcessArgv(process4.argv);
@@ -790,6 +834,11 @@ var Docula = class {
       }
     }
   }
+  /**
+   * Checks if the site is a single page website
+   * @param {string} sitePath
+   * @returns {boolean}
+   */
   isSinglePageWebsite(sitePath) {
     const documentationPath = `${sitePath}/docs`;
     if (!fs3.existsSync(documentationPath)) {
@@ -798,6 +847,11 @@ var Docula = class {
     const files = fs3.readdirSync(documentationPath);
     return files.length === 0;
   }
+  /**
+   * Generate the init files
+   * @param {string} sitePath
+   * @returns {void}
+   */
   generateInit(sitePath) {
     if (!fs3.existsSync(sitePath)) {
       fs3.mkdirSync(sitePath);
@@ -809,11 +863,20 @@ var Docula = class {
     fs3.copyFileSync("./init/variables.css", `${sitePath}/variables.css`);
     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.`);
   }
+  /**
+   * Get the version of the package
+   * @returns {string}
+   */
   getVersion() {
     const packageJson = fs3.readFileSync("./package.json", "utf8");
     const packageObject = JSON.parse(packageJson);
     return packageObject.version;
   }
+  /**
+   * Load the config file
+   * @param {string} sitePath
+   * @returns {Promise<void>}
+   */
   async loadConfigFile(sitePath) {
     if (fs3.existsSync(sitePath)) {
       const configFile = `${sitePath}/docula.config.mjs`;
@@ -822,6 +885,11 @@ var Docula = class {
       }
     }
   }
+  /**
+   * Serve the site based on the options (port and output path)
+   * @param {DoculaOptions} options
+   * @returns {Promise<void>}
+   */
   async serve(options) {
     if (this._server) {
       this._server.close();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docula",
-  "version": "0.9.3",
+  "version": "0.9.5",
   "description": "Beautiful Website for Your Projects",
   "type": "module",
   "main": "./dist/docula.js",
@@ -48,26 +48,26 @@
   "dependencies": {
     "axios": "^1.7.7",
     "cheerio": "^1.0.0",
-    "ecto": "^4.1.2",
+    "ecto": "^4.1.3",
     "express": "^4.21.1",
     "feed": "^4.2.2",
     "gray-matter": "^4.0.3",
     "he": "^1.2.0",
-    "js-yaml": "^4.1.0",
-    "update-notifier": "^7.3.1"
+    "update-notifier": "^7.3.1",
+    "writr": "^4.1.4"
   },
   "devDependencies": {
     "@types/express": "^5.0.0",
     "@types/he": "^1.2.3",
     "@types/js-yaml": "^4.0.9",
-    "@types/node": "^22.7.5",
+    "@types/node": "^22.9.0",
     "@types/update-notifier": "^6.0.8",
-    "@vitest/coverage-v8": "^2.1.2",
+    "@vitest/coverage-v8": "^2.1.5",
     "rimraf": "^6.0.1",
-    "tsup": "^8.3.0",
+    "tsup": "^8.3.5",
     "typescript": "^5.6.3",
-    "vitest": "^2.1.2",
-    "webpack": "^5.95.0",
+    "vitest": "^2.1.5",
+    "webpack": "^5.96.1",
     "xo": "^0.59.3"
   },
   "xo": {

package/template/css/base.css

@@ -220,6 +220,8 @@ footer img {
   font-weight: 700;
   font-size: 1.5rem;
   line-height: 2rem;
+  margin-top: 1.75rem;
+  margin-bottom: 1rem;
 }
 
 .content h2 {