@qubit-ltd/jsdoc-theme 1.3.3

package/clean-jsdoc-theme-defaults.js

@@ -0,0 +1,37 @@
+const SECTION_TYPE = {
+  Classes: "Classes",
+  Modules: "Modules",
+  Externals: "Externals",
+  Events: "Events",
+  Namespaces: "Namespaces",
+  Mixins: "Mixins",
+  Tutorials: "Tutorials",
+  Interfaces: "Interfaces",
+  Global: "Global",
+};
+
+const defaultSections = [
+  SECTION_TYPE.Modules,
+  SECTION_TYPE.Classes,
+  SECTION_TYPE.Externals,
+  SECTION_TYPE.Events,
+  SECTION_TYPE.Namespaces,
+  SECTION_TYPE.Mixins,
+  SECTION_TYPE.Tutorials,
+  SECTION_TYPE.Interfaces,
+  SECTION_TYPE.Global,
+];
+
+const HTML_MINIFY_OPTIONS = {
+  collapseWhitespace: true,
+  removeComments: true,
+  html5: true,
+  minifyJS: true,
+  minifyCSS: true,
+};
+
+module.exports = {
+  HTML_MINIFY_OPTIONS,
+  SECTION_TYPE,
+  defaultSections,
+};

package/clean-jsdoc-theme-helper.js

@@ -0,0 +1,186 @@
+const has = require("lodash/has");
+const klawSync = require("klaw-sync");
+const path = require("path");
+const fse = require("fs-extra");
+const showdown = require("showdown");
+
+const mdToHTMLConverter = new showdown.Converter();
+
+function lsSync(dir, opts = {}) {
+  const depth = has(opts, "depth") ? opts.depth : -1;
+
+  const files = klawSync(dir, {
+    depthLimit: depth,
+    filter: (f) => !path.basename(f.path).startsWith("."),
+    nodir: true,
+  });
+
+  return files.map((f) => f.path);
+}
+
+function copyToOutputFolder(filePath, outdir) {
+  const resolvedPath = path.resolve(filePath);
+  const filename = path.basename(resolvedPath);
+  const out = path.join(outdir, filename);
+
+  fse.copyFileSync(resolvedPath, out);
+}
+
+function copyToOutputFolderFromArray(filePathArray, outdir) {
+  const outputList = [];
+
+  if (Array.isArray(filePathArray)) {
+    for (const filePath of filePathArray) {
+      if (typeof filePath === "string") {
+        copyToOutputFolder(filePath, outdir);
+        outputList.push(path.basename(filePath));
+      } else if (typeof filePath === "object") {
+        const { filepath, targets } = filePath;
+
+        copyToOutputFolder(filepath, outdir);
+        outputList.push({ filepath: path.basename(filepath), targets });
+      }
+    }
+  }
+
+  return outputList;
+}
+
+function buildFooter(themeOpts) {
+  var footer = themeOpts.footer;
+
+  return footer;
+}
+
+function moduleHeader(themeOpts) {
+  var displayModuleHeader = themeOpts.displayModuleHeader || false;
+
+  return displayModuleHeader;
+}
+
+function getFavicon(themeOpts) {
+  var favicon = themeOpts.favicon || undefined;
+
+  return favicon;
+}
+
+// function copy
+function createDynamicStyleSheet(themeOpts) {
+  var styleClass = themeOpts.create_style || undefined;
+  /* prettier-ignore-start */
+
+  return styleClass;
+}
+
+function createDynamicsScripts(themeOpts) {
+  var scripts = themeOpts.add_scripts || undefined;
+
+  return scripts;
+}
+
+function returnPathOfScriptScr(themeOpts) {
+  var scriptPath = themeOpts.add_script_path || undefined;
+
+  return scriptPath;
+}
+
+function returnPathOfStyleSrc(themeOpts) {
+  var stylePath = themeOpts.add_style_path || undefined;
+
+  return stylePath;
+}
+
+function includeCss(themeOpts, outdir) {
+  var stylePath = themeOpts.include_css || undefined;
+
+  if (stylePath) {
+    stylePath = copyToOutputFolderFromArray(stylePath, outdir);
+  }
+
+  return stylePath;
+}
+
+function resizeable(themeOpts) {
+  var resizeOpts = themeOpts.resizeable || {};
+
+  return resizeOpts;
+}
+
+function codepen(themeOpts) {
+  var codepenOpts = themeOpts.codepen || {};
+
+  return codepenOpts;
+}
+
+function includeScript(themeOpts, outdir) {
+  var scriptPath = themeOpts.include_js || undefined;
+
+  if (scriptPath) {
+    scriptPath = copyToOutputFolderFromArray(scriptPath, outdir);
+  }
+
+  return scriptPath;
+}
+
+function getMetaTagData(themeOpts) {
+  var meta = themeOpts.meta || undefined;
+
+  return meta;
+}
+
+function getTheme(themeOpts) {
+  var theme = themeOpts.default_theme || "dark";
+
+  return theme;
+}
+
+function getBaseURL(themeOpts) {
+  return themeOpts.base_url;
+}
+
+function copyStaticFolder(themeOpts, outdir) {
+  const staticDir = themeOpts.static_dir || undefined;
+
+  if (staticDir) {
+    for (const dir of staticDir) {
+      const output = path.join(outdir, dir);
+
+      fse.copySync(dir, output);
+    }
+  }
+}
+
+/**
+ * Currently for some reason yields markdown is
+ * not processed by jsdoc. So, we are processing it here
+ *
+ * @param {Array<{type: string, description: string}>} yields
+ */
+function getProcessedYield(yields) {
+  if (!Array.isArray(yields)) return [];
+
+  return yields.map((y) => ({
+    ...y,
+    description: mdToHTMLConverter.makeHtml(y.description),
+  }));
+}
+
+module.exports = {
+  buildFooter,
+  moduleHeader,
+  codepen,
+  createDynamicStyleSheet,
+  createDynamicsScripts,
+  getBaseURL,
+  getFavicon,
+  getMetaTagData,
+  getTheme,
+  includeCss,
+  includeScript,
+  resizeable,
+  returnPathOfScriptScr,
+  returnPathOfStyleSrc,
+  copyStaticFolder,
+  getProcessedYield,
+  lsSync,
+};

package/helpers/Environment.html

@@ -0,0 +1,3 @@
+<!DOCTYPE html><html lang="en" style="font-size:16px"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><meta name="Author" content="Ankit Kumar"><meta name="Description" content="A beautifully crafted theme for jsdoc"><script src="script.js"></script><link type="text/css" rel="stylesheet" href="style.css"><title>Class: Environment</title><!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]--><script src="scripts/third-party/hljs.js" defer="defer"></script><script src="scripts/third-party/hljs-line-num.js" defer="defer"></script><script src="scripts/third-party/popper.js" defer="defer"></script><script src="scripts/third-party/tippy.js" defer="defer"></script><script src="scripts/third-party/tocbot.min.js"></script><script>var baseURL="/",locationPathname="";baseURL=(locationPathname=document.location.pathname).substr(0,locationPathname.lastIndexOf("/")+1)</script><link rel="stylesheet" href="styles/clean-jsdoc-theme.min.css"><style>.test-create-style{background:red}</style><svg aria-hidden="true" version="1.1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" style="display:none"><defs><symbol id="copy-icon" viewbox="0 0 488.3 488.3"><g><path d="M314.25,85.4h-227c-21.3,0-38.6,17.3-38.6,38.6v325.7c0,21.3,17.3,38.6,38.6,38.6h227c21.3,0,38.6-17.3,38.6-38.6V124    C352.75,102.7,335.45,85.4,314.25,85.4z M325.75,449.6c0,6.4-5.2,11.6-11.6,11.6h-227c-6.4,0-11.6-5.2-11.6-11.6V124    c0-6.4,5.2-11.6,11.6-11.6h227c6.4,0,11.6,5.2,11.6,11.6V449.6z"/><path d="M401.05,0h-227c-21.3,0-38.6,17.3-38.6,38.6c0,7.5,6,13.5,13.5,13.5s13.5-6,13.5-13.5c0-6.4,5.2-11.6,11.6-11.6h227    c6.4,0,11.6,5.2,11.6,11.6v325.7c0,6.4-5.2,11.6-11.6,11.6c-7.5,0-13.5,6-13.5,13.5s6,13.5,13.5,13.5c21.3,0,38.6-17.3,38.6-38.6    V38.6C439.65,17.3,422.35,0,401.05,0z"/></g></symbol><symbol id="search-icon" viewBox="0 0 512 512"><g><g><path d="M225.474,0C101.151,0,0,101.151,0,225.474c0,124.33,101.151,225.474,225.474,225.474    c124.33,0,225.474-101.144,225.474-225.474C450.948,101.151,349.804,0,225.474,0z M225.474,409.323    c-101.373,0-183.848-82.475-183.848-183.848S124.101,41.626,225.474,41.626s183.848,82.475,183.848,183.848    S326.847,409.323,225.474,409.323z"/></g></g><g><g><path d="M505.902,476.472L386.574,357.144c-8.131-8.131-21.299-8.131-29.43,0c-8.131,8.124-8.131,21.306,0,29.43l119.328,119.328    c4.065,4.065,9.387,6.098,14.715,6.098c5.321,0,10.649-2.033,14.715-6.098C514.033,497.778,514.033,484.596,505.902,476.472z"/></g></g></symbol><symbol id="font-size-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11.246 15H4.754l-2 5H.6L7 4h2l6.4 16h-2.154l-2-5zm-.8-2L8 6.885 5.554 13h4.892zM21 12.535V12h2v8h-2v-.535a4 4 0 1 1 0-6.93zM19 18a2 2 0 1 0 0-4 2 2 0 0 0 0 4z"/></symbol><symbol id="add-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M11 11V5h2v6h6v2h-6v6h-2v-6H5v-2z"/></symbol><symbol id="minus-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M5 11h14v2H5z"/></symbol><symbol id="dark-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M10 7a7 7 0 0 0 12 4.9v.1c0 5.523-4.477 10-10 10S2 17.523 2 12 6.477 2 12 2h.1A6.979 6.979 0 0 0 10 7zm-6 5a8 8 0 0 0 15.062 3.762A9 9 0 0 1 8.238 4.938 7.999 7.999 0 0 0 4 12z"/></symbol><symbol id="light-theme-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 18a6 6 0 1 1 0-12 6 6 0 0 1 0 12zm0-2a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM11 1h2v3h-2V1zm0 19h2v3h-2v-3zM3.515 4.929l1.414-1.414L7.05 5.636 5.636 7.05 3.515 4.93zM16.95 18.364l1.414-1.414 2.121 2.121-1.414 1.414-2.121-2.121zm2.121-14.85l1.414 1.415-2.121 2.121-1.414-1.414 2.121-2.121zM5.636 16.95l1.414 1.414-2.121 2.121-1.414-1.414 2.121-2.121zM23 11v2h-3v-2h3zM4 11v2H1v-2h3z"/></symbol><symbol id="reset-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M18.537 19.567A9.961 9.961 0 0 1 12 22C6.477 22 2 17.523 2 12S6.477 2 12 2s10 4.477 10 10c0 2.136-.67 4.116-1.81 5.74L17 12h3a8 8 0 1 0-2.46 5.772l.997 1.795z"/></symbol><symbol id="down-icon" viewBox="0 0 16 16"><path fill-rule="evenodd" clip-rule="evenodd" d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z"></path></symbol><symbol id="codepen-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M16.5 13.202L13 15.535v3.596L19.197 15 16.5 13.202zM14.697 12L12 10.202 9.303 12 12 13.798 14.697 12zM20 10.869L18.303 12 20 13.131V10.87zM19.197 9L13 4.869v3.596l3.5 2.333L19.197 9zM7.5 10.798L11 8.465V4.869L4.803 9 7.5 10.798zM4.803 15L11 19.131v-3.596l-3.5-2.333L4.803 15zM4 13.131L5.697 12 4 10.869v2.262zM2 9a1 1 0 0 1 .445-.832l9-6a1 1 0 0 1 1.11 0l9 6A1 1 0 0 1 22 9v6a1 1 0 0 1-.445.832l-9 6a1 1 0 0 1-1.11 0l-9-6A1 1 0 0 1 2 15V9z"/></symbol><symbol id="close-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M12 10.586l4.95-4.95 1.414 1.414-4.95 4.95 4.95 4.95-1.414 1.414-4.95-4.95-4.95 4.95-1.414-1.414 4.95-4.95-4.95-4.95L7.05 5.636z"/></symbol><symbol id="menu-icon" viewBox="0 0 24 24"><path fill="none" d="M0 0h24v24H0z"/><path d="M3 4h18v2H3V4zm0 7h18v2H3v-2zm0 7h18v2H3v-2z"/></symbol></defs></svg></head><body class="dark" data-theme="dark"><div class="sidebar-container"><div class="sidebar" id="sidebar"><a href="/" class="sidebar-title sidebar-title-anchor">clean-jsdoc-theme</a><div class="sidebar-items-container"><div class="sidebar-section-title with-arrow" data-isopen="false" id="lUrjRXtWbw7TgUHpOpeIs"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-SqlJs.html">SqlJs</a></div><div class="sidebar-section-children"><a href="module-bookshelf.html">bookshelf</a></div><div class="sidebar-section-children"><a href="module-color_mixer.html">color/mixer</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="axG7kDgeAPeZ5DHapLq1d"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Alive.html">Alive</a></div><div class="sidebar-section-children"><a href="Apple.html">Apple</a></div><div class="sidebar-section-children"><a href="Database.html">Database</a></div><div class="sidebar-section-children"><a href="Energy.html">Energy</a></div><div class="sidebar-section-children"><a href="Environment.html">Environment</a></div><div class="sidebar-section-children"><a href="Statement.html">Statement</a></div><div class="sidebar-section-children"><a href="StatementIterator.html">StatementIterator</a></div><div class="sidebar-section-children"><a href="Test.html">Test</a></div><div class="sidebar-section-children"><a href="Tree.html">Tree</a></div><div class="sidebar-section-children"><a href="World.html">World</a></div><div class="sidebar-section-children"><a href="module-bookshelf.Book.html" class="has-anchor"><span class="ancestors">bookshelf~ </span>Book</a></div><div class="sidebar-section-children"><a href="module-color_mixer-Colour.html" class="has-anchor"><span class="ancestors">color_mixer~ </span>Colour</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="BWZtTwBCXCWgbevKSQKPL"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Apple.html#event:beEaten">beEaten</a></div><div class="sidebar-section-children"><a href="Environment.html#event:beforeDestroy">beforeDestroy</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="6udUSs5-PJoqnSItnJHu5"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="obj.map.html">map</a></div><div class="sidebar-section-children"><a href="pieOptions.html">pieOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="FTgL4gY1UQX8gtVdugX3V"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Alive_.html">Alive</a></div><div class="sidebar-section-children"><a href="tutorial-Apple_.html">Apple</a></div><div class="sidebar-section-children"><a href="tutorial-Environment_.html">Environment</a></div><div class="sidebar-section-children"><a href="tutorial-new.html">new</a></div><div class="sidebar-section-children"><a href="tutorial-Other.html">Other</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="E4zOAQLXxH4qLBVcwgklg"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#AliveEnergy">AliveEnergy</a></div><div class="sidebar-section-children"><a href="global.html#EnergyUnit">EnergyUnit</a></div><div class="sidebar-section-children"><a href="global.html#EnvironmentConfiguration">EnvironmentConfiguration</a></div><div class="sidebar-section-children"><a href="global.html#PhotoSize">PhotoSize</a></div><div class="sidebar-section-children"><a href="global.html#SqlJs">SqlJs</a></div><div class="sidebar-section-children"><a href="global.html#SqlJsConfig">SqlJsConfig</a></div><div class="sidebar-section-children"><a href="global.html#fibonacci">fibonacci</a></div><div class="sidebar-section-children"><a href="global.html#initSqlJs">initSqlJs</a></div></div></div></div></div><div class="navbar-container" id="VuAckcnZhf"><nav class="navbar"><div class="navbar-left-items"><div class="navbar-item"><a id="github" href="https://github.com/ankitskvmdam/clean-jsdoc-theme" target="">Github</a></div><div class="navbar-item"><a id="npm" href="https://www.npmjs.com/package/clean-jsdoc-theme" target="">npm</a></div></div><div class="navbar-right-items"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div><nav></nav></nav></div><div class="toc-container"><div class="toc-content"><span class="bold">On this page</span><div id="eed4d2a0bfd64539bb9df78095dec881"></div></div></div><div class="body-wrapper"><div class="main-content"><div class="main-wrapper"><section><header><h1 id="Environment-title" class="has-anchor">Environment</h1><div class="class-description"><p>Lorem ipsum dolor sit amet, {@link Energy} consectetur adipiscing elit. Vestibulum condimentum tempus diam. Ut eget ultricies metus, vitae ornare turpis. Vivamus lectus metus, euismod quis tortor quis, pretium semper massa. Nulla mauris sapien, faucibus vitae metus et, ultrices fringilla sem. Sed laoreet tempor odio, elementum scelerisque nunc aliquet quis.</p></div></header><article><div class="container-overview"><h2 id="constructor" class="has-anchor">Constructor</h2><h3 class="name has-anchor" id="Environment"><span class="type-signature"></span>new Environment<span class="signature">()</span></h3><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="Environment.js.html">Environment.js</a>, <a href="Environment.js.html#line6">line 6</a></li></ul></dd></div></dl></div><h2 id="members" class="subsection-title has-anchor">Members</h2><h3 class="name has-anchor" id="livingThings"><span class="type-signature"></span>livingThings<span class="type-signature"> :Array.&lt;<a href="Alive.html">Alive</a>></span></h3><div class="description"><p>All the living things in this environment</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">Array.&lt;<a href="Alive.html">Alive</a>></span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="Environment.js.html">Environment.js</a>, <a href="Environment.js.html#line12">line 12</a></li></ul></dd></div></dl><h3 class="name has-anchor" id="name"><span class="type-signature"></span>name<span class="type-signature"> :String</span></h3><div class="description"><p>The name of this environment</p></div><div class="member-item-container flex"><strong>Type:</strong><ul><li><span class="param-type">String</span></li></ul></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="Environment.js.html">Environment.js</a>, <a href="Environment.js.html#line18">line 18</a></li></ul></dd></div></dl><h2 id="methods" class="subsection-title has-anchor">Methods</h2><h3 class="name has-anchor" id="start"><span class="type-signature"></span>start<span class="signature">(config)</span></h3><div class="description"><p>Vestibulum condimentum tempus {@link Alive} diam.</p></div><div class="method-member-container flex flex-col w-100 overflow-auto mt-20"><strong>Parameters:</strong><table class="params"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>config</code></td><td class="type"><span class="param-type"><a href="global.html#EnvironmentConfiguration">EnvironmentConfiguration</a></span></td><td class="description last"></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="Environment.js.html">Environment.js</a>, <a href="Environment.js.html#line25">line 25</a></li></ul></dd></div></dl><h2 id="events" class="subsection-title has-anchor">Events</h2><h3 class="name has-anchor" id="event:beforeDestroy">beforeDestroy</h3><div class="description"><p>Lorem ipsum dolor sit amet, {@link Energy} consectetur adipiscing el</p></div><div class="method-member-container mt-20"><strong>Type:</strong><ul><li><span class="param-type"><a href="Energy.html">Energy</a></span></li></ul></div><b class="subsection-title">Properties</b><div class="allow-overflow"><table class="props"><thead><tr><th>Name</th><th>Type</th><th class="last">Description</th></tr></thead><tbody><tr><td class="name"><code>foo</code></td><td class="type"><span class="param-type">boolean</span></td><td class="description last"><p>aalks djlas</p></td></tr></tbody></table></div><dl class="details"><div class="details-item-container"><dt class="tag-source bold">Source</dt><dd class="tag-source"><ul><li><a href="Environment.js.html">Environment.js</a>, <a href="Environment.js.html#line36">line 36</a></li></ul></dd></div></dl></article></section><footer class="footer" id="PeOAagUepe"><div class="wrapper"><div style="margin-bottom:.5rem">clean-jsdoc-theme</div>Fork: <a href="https://github.com/ankitskvmdam/clean-jsdoc-theme">https://github.com/ankitskvmdam/clean-jsdoc-theme</a></div></footer></div></div></div><div class="search-container" id="PkfLWpAbet" style="display:none"><div class="wrapper" id="iCxFxjkHbP"><button class="icon-button search-close-button" id="VjLlGakifb" aria-label="close search"><svg><use xlink:href="#close-icon"></use></svg></button><div class="search-box-c"><svg><use xlink:href="#search-icon"></use></svg> <input type="text" id="vpcKVYIppa" class="search-input" placeholder="Search..." autofocus></div><div class="search-result-c" id="fWwVHRuDuN"><span class="search-result-c-text">Type anything to view search result</span></div></div></div><div class="mobile-menu-icon-container"><button class="icon-button" id="mobile-menu" data-isopen="false" aria-label="menu"><svg><use xlink:href="#menu-icon"></use></svg></button></div><div id="mobile-sidebar" class="mobile-sidebar-container"><div class="mobile-sidebar-wrapper"><a href="/" class="sidebar-title sidebar-title-anchor">clean-jsdoc-theme</a><div class="mobile-nav-links"><div class="navbar-item"><a id="github-mobile" href="https://github.com/ankitskvmdam/clean-jsdoc-theme" target="">Github</a></div><div class="navbar-item"><a id="npm-mobile" href="https://www.npmjs.com/package/clean-jsdoc-theme" target="">npm</a></div></div><div class="mobile-sidebar-items-c"><div class="sidebar-section-title with-arrow" data-isopen="false" id="lUrjRXtWbw7TgUHpOpeIs"><div>Modules</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="module-SqlJs.html">SqlJs</a></div><div class="sidebar-section-children"><a href="module-bookshelf.html">bookshelf</a></div><div class="sidebar-section-children"><a href="module-color_mixer.html">color/mixer</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="axG7kDgeAPeZ5DHapLq1d"><div>Classes</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Alive.html">Alive</a></div><div class="sidebar-section-children"><a href="Apple.html">Apple</a></div><div class="sidebar-section-children"><a href="Database.html">Database</a></div><div class="sidebar-section-children"><a href="Energy.html">Energy</a></div><div class="sidebar-section-children"><a href="Environment.html">Environment</a></div><div class="sidebar-section-children"><a href="Statement.html">Statement</a></div><div class="sidebar-section-children"><a href="StatementIterator.html">StatementIterator</a></div><div class="sidebar-section-children"><a href="Test.html">Test</a></div><div class="sidebar-section-children"><a href="Tree.html">Tree</a></div><div class="sidebar-section-children"><a href="World.html">World</a></div><div class="sidebar-section-children"><a href="module-bookshelf.Book.html" class="has-anchor"><span class="ancestors">bookshelf~ </span>Book</a></div><div class="sidebar-section-children"><a href="module-color_mixer-Colour.html" class="has-anchor"><span class="ancestors">color_mixer~ </span>Colour</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="BWZtTwBCXCWgbevKSQKPL"><div>Events</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="Apple.html#event:beEaten">beEaten</a></div><div class="sidebar-section-children"><a href="Environment.html#event:beforeDestroy">beforeDestroy</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="6udUSs5-PJoqnSItnJHu5"><div>Namespaces</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="obj.map.html">map</a></div><div class="sidebar-section-children"><a href="pieOptions.html">pieOptions</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="FTgL4gY1UQX8gtVdugX3V"><div>Tutorials</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="tutorial-Alive_.html">Alive</a></div><div class="sidebar-section-children"><a href="tutorial-Apple_.html">Apple</a></div><div class="sidebar-section-children"><a href="tutorial-Environment_.html">Environment</a></div><div class="sidebar-section-children"><a href="tutorial-new.html">new</a></div><div class="sidebar-section-children"><a href="tutorial-Other.html">Other</a></div></div><div class="sidebar-section-title with-arrow" data-isopen="false" id="E4zOAQLXxH4qLBVcwgklg"><div>Global</div><svg><use xlink:href="#down-icon"></use></svg></div><div class="sidebar-section-children-container"><div class="sidebar-section-children"><a href="global.html#AliveEnergy">AliveEnergy</a></div><div class="sidebar-section-children"><a href="global.html#EnergyUnit">EnergyUnit</a></div><div class="sidebar-section-children"><a href="global.html#EnvironmentConfiguration">EnvironmentConfiguration</a></div><div class="sidebar-section-children"><a href="global.html#PhotoSize">PhotoSize</a></div><div class="sidebar-section-children"><a href="global.html#SqlJs">SqlJs</a></div><div class="sidebar-section-children"><a href="global.html#SqlJsConfig">SqlJsConfig</a></div><div class="sidebar-section-children"><a href="global.html#fibonacci">fibonacci</a></div><div class="sidebar-section-children"><a href="global.html#initSqlJs">initSqlJs</a></div></div></div><div class="mobile-navbar-actions"><div class="navbar-right-item"><button class="icon-button search-button" aria-label="open-search"><svg><use xlink:href="#search-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button theme-toggle" aria-label="toggle-theme"><svg><use class="theme-svg-use" xlink:href="#light-theme-icon"></use></svg></button></div><div class="navbar-right-item"><button class="icon-button font-size" aria-label="change-font-size"><svg><use xlink:href="#font-size-icon"></use></svg></button></div></div></div></div><script type="text/javascript" src="scripts/core.min.js"></script><script src="scripts/search.min.js" defer="defer"></script><script src="scripts/third-party/fuse.js" defer="defer"></script><script type="text/javascript">function foo(){console.log("foo")}function bar(){console.log("bar")}bar(),foo()</script><script type="text/javascript">var tocbotInstance=tocbot.init({tocSelector:"#eed4d2a0bfd64539bb9df78095dec881",contentSelector:".main-content",headingSelector:"h1, h2, h3",hasInnerContainers:!0,scrollContainer:".main-content",headingsOffset:130,onClick:bringLinkToView})</script></body></html>

package/helpers/down-arrow.js

@@ -0,0 +1,9 @@
+const upIcon = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 16 16" width="16" height="16">
+    <path 
+        fill-rule="evenodd" 
+        clip-rule="evenodd" 
+        d="M12.7803 6.21967C13.0732 6.51256 13.0732 6.98744 12.7803 7.28033L8.53033 11.5303C8.23744 11.8232 7.76256 11.8232 7.46967 11.5303L3.21967 7.28033C2.92678 6.98744 2.92678 6.51256 3.21967 6.21967C3.51256 5.92678 3.98744 5.92678 4.28033 6.21967L8 9.93934L11.7197 6.21967C12.0126 5.92678 12.4874 5.92678 12.7803 6.21967Z">
+    </path>
+</svg>`;
+
+module.exports = upIcon;

package/helpers/i18n.js

@@ -0,0 +1,106 @@
+/**
+ * Internationalization helper for JSDoc templates
+ */
+
+const fs = require("fs");
+const path = require("path");
+
+let currentLanguage = "en";
+let translations = {};
+
+/**
+ * Load translation files
+ * @param {string} language - Language code (en, zh)
+ */
+function loadTranslations(language) {
+  const translationPath = path.join(
+    __dirname,
+    "..",
+    "i18n",
+    `${language}.json`
+  );
+
+  try {
+    if (fs.existsSync(translationPath)) {
+      const content = fs.readFileSync(translationPath, "utf8");
+      translations[language] = JSON.parse(content);
+      return true;
+    }
+  } catch (error) {
+    console.warn(
+      `Failed to load translations for language: ${language}`,
+      error.message
+    );
+  }
+
+  return false;
+}
+
+/**
+ * Set current language
+ * @param {string} language - Language code
+ */
+function setLanguage(language) {
+  currentLanguage = language;
+
+  // Load translations if not already loaded
+  if (!translations[language]) {
+    loadTranslations(language);
+  }
+}
+
+/**
+ * Get translated text
+ * @param {string} key - Translation key
+ * @param {string} [fallback] - Fallback text if translation not found
+ * @returns {string} Translated text
+ */
+function t(key, fallback) {
+  const langTranslations = translations[currentLanguage];
+
+  if (langTranslations && langTranslations[key]) {
+    return langTranslations[key];
+  }
+
+  // Try English as fallback
+  if (currentLanguage !== "en" && translations.en && translations.en[key]) {
+    return translations.en[key];
+  }
+
+  // Return fallback or key itself
+  return fallback || key;
+}
+
+/**
+ * Get current language
+ * @returns {string} Current language code
+ */
+function getCurrentLanguage() {
+  return currentLanguage;
+}
+
+/**
+ * Initialize i18n system
+ * @param {Object} options - Configuration options
+ * @param {string} [options.language='en'] - Default language
+ */
+function init(options = {}) {
+  const language = options.language || "en";
+
+  // Load English translations (always available as fallback)
+  loadTranslations("en");
+
+  // Load requested language if different
+  if (language !== "en") {
+    loadTranslations(language);
+  }
+
+  setLanguage(language);
+}
+
+module.exports = {
+  init,
+  setLanguage,
+  getCurrentLanguage,
+  t,
+};

package/i18n/en.json

@@ -0,0 +1,76 @@
+{
+  "constructor": "Constructor",
+  "properties": "Properties",
+  "members": "Members",
+  "methods": "Methods",
+  "parameters": "Parameters",
+  "returns": "Returns",
+  "type": "Type",
+  "name": "Name",
+  "description": "Description",
+  "default": "Default",
+  "attributes": "Attributes",
+  "examples": "Examples",
+  "example": "Example",
+  "extends": "Extends",
+  "source": "Source",
+  "version": "Version",
+  "since": "Since",
+  "author": "Author",
+  "see": "See",
+  "throws": "Throws",
+  "fires": "Fires",
+  "listens": "Listens",
+  "mixes": "Mixes",
+  "namespace": "Namespace",
+  "namespaces": "Namespaces",
+  "class": "Class",
+  "classes": "Classes",
+  "function": "Function",
+  "method": "Method",
+  "event": "Event",
+  "events": "Events",
+  "typedef": "Typedef",
+  "global": "Global",
+  "module": "Module",
+  "requires": "Requires",
+  "interfaces": "Interfaces",
+  "mixins": "Mixins",
+  "type_definitions": "Type Definitions",
+  "optional": "optional",
+  "nullable": "nullable",
+  "repeatable": "repeatable",
+  "this": "This",
+  "yields": "Yields",
+  "listeners_of_this_event": "Listeners of This Event",
+  "listens_to_events": "Listens to Events",
+  "modifies": "Modifies",
+  "inherited_from": "Inherited From",
+  "overrides": "Overrides",
+  "deprecated": "Deprecated",
+  "implementations": "Implementations",
+  "implements": "Implements",
+  "mixes_in": "Mixes In",
+  "copyright": "Copyright",
+  "license": "License",
+  "default_value": "Default Value",
+  "todo": "To Do",
+  "yes": "Yes",
+  "tutorial": "Tutorial",
+  "tutorials": "Tutorials",
+  "home": "Home",
+  "search": "Search",
+  "toggle_theme": "Toggle Theme",
+  "change_font_size": "Change Font Size",
+  "go_to_homepage": "Go to Homepage",
+  "open_search": "Open Search",
+  "close_search": "Close Search",
+  "toggle_theme_tooltip": "Toggle Theme",
+  "search_tooltip": "Search",
+  "font_size_tooltip": "Change font size",
+  "home_tooltip": "Go to Homepage",
+  "on_this_page": "On this page",
+  "search_placeholder": "Search...",
+  "search_hint": "Type anything to view search result",
+  "open_in_codepen": "Open in CodePen"
+}

package/i18n/zh.json

@@ -0,0 +1,76 @@
+{
+  "constructor": "构造函数",
+  "properties": "属性",
+  "members": "成员",
+  "methods": "方法",
+  "parameters": "参数",
+  "returns": "返回值",
+  "type": "类型",
+  "name": "名称",
+  "description": "描述",
+  "default": "默认值",
+  "attributes": "特性",
+  "examples": "示例",
+  "example": "示例",
+  "extends": "继承",
+  "source": "源码",
+  "version": "版本",
+  "since": "起始版本",
+  "author": "作者",
+  "see": "参见",
+  "throws": "抛出异常",
+  "fires": "触发事件",
+  "listens": "监听事件",
+  "mixes": "混入",
+  "namespace": "命名空间",
+  "namespaces": "命名空间",
+  "class": "类",
+  "classes": "类",
+  "function": "函数",
+  "method": "方法",
+  "event": "事件",
+  "events": "事件",
+  "typedef": "类型定义",
+  "global": "全局",
+  "module": "模块",
+  "requires": "依赖",
+  "interfaces": "接口",
+  "mixins": "混入",
+  "type_definitions": "类型定义",
+  "optional": "可选",
+  "nullable": "可为空",
+  "repeatable": "可重复",
+  "this": "上下文",
+  "yields": "产出",
+  "listeners_of_this_event": "此事件的监听器",
+  "listens_to_events": "监听事件",
+  "modifies": "修改",
+  "inherited_from": "继承自",
+  "overrides": "重写",
+  "deprecated": "已废弃",
+  "implementations": "实现",
+  "implements": "实现接口",
+  "mixes_in": "混入",
+  "copyright": "版权",
+  "license": "许可证",
+  "default_value": "默认值",
+  "todo": "待办",
+  "yes": "是",
+  "tutorial": "教程",
+  "tutorials": "教程",
+  "home": "首页",
+  "search": "搜索",
+  "toggle_theme": "切换主题",
+  "change_font_size": "更改字体大小",
+  "go_to_homepage": "回到首页",
+  "open_search": "打开搜索",
+  "close_search": "关闭搜索",
+  "toggle_theme_tooltip": "切换主题",
+  "search_tooltip": "搜索",
+  "font_size_tooltip": "更改字体大小",
+  "home_tooltip": "回到首页",
+  "on_this_page": "本页内容",
+  "search_placeholder": "搜索...",
+  "search_hint": "输入任何内容查看搜索结果",
+  "open_in_codepen": "在 CodePen 中打开"
+}

package/package.json

@@ -0,0 +1,83 @@
+{
+    "name": "@qubit-ltd/jsdoc-theme",
+    "version": "1.3.3",
+    "description": "A customized JSDoc theme based on clean-jsdoc-theme, enhanced with properties table and constructor detection features for Qubit projects.",
+    "main": "publish.js",
+    "author": "Haixing Hu (starfish.hu@gmail.com)",
+    "license": "Apache-2.0",
+    "scripts": {
+        "build": "node minify.js",
+        "build:demo": "node minify.js && node node_modules/jsdoc/jsdoc.js -c jsdoc-config.json",
+        "lint:js": "eslint . --ext .js --fix",
+        "lint:style": "stylelint-config-prettier-check && stylelint static/styles/",
+        "lint": "npm run lint:js && npm run lint:style",
+        "prepublishOnly": "npm run lint && npm run build",
+        "deploy": "npm run lint && npm run build && npm publish --registry='https://npm.qubit.ltd/' --access public",
+        "deploy:public": "npm run lint && npm run build && npm publish --registry='https://registry.npmjs.org/' --access public",
+        "deploy:all": "npm run deploy && npm publish --registry='https://registry.npmjs.org/' --access public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/Haixing-Hu/qubit-jsdoc-theme.git"
+    },
+    "bugs": {
+        "url": "https://github.com/Haixing-Hu/qubit-jsdoc-theme/issues"
+    },
+    "homepage": "https://github.com/Haixing-Hu/qubit-jsdoc-theme",
+    "files": [
+        "publish.js",
+        "tmpl/**/*",
+        "static/**/*",
+        "helpers/**/*",
+        "i18n/**/*",
+        "clean-jsdoc-theme-defaults.js",
+        "clean-jsdoc-theme-helper.js",
+        "LICENSE",
+        "README.md",
+        "CHANGELOG.md"
+    ],
+    "peerDependencies": {
+        "jsdoc": ">=3.x <=4.x"
+    },
+    "keywords": [
+        "jsdoc",
+        "template",
+        "jsdoc-template",
+        "javascript documentation",
+        "qubit",
+        "properties table",
+        "constructor detection",
+        "customizable jsdoc theme"
+    ],
+    "devDependencies": {
+        "@babel/core": "^7.28.3",
+        "@babel/eslint-parser": "^7.28.0",
+        "@jsdoc/eslint-config": "^1.1.6",
+        "concurrently": "^7.2.2",
+        "csso": "^5.0.3",
+        "eslint": "^8.19.0",
+        "eslint-config-prettier": "^8.5.0",
+        "eslint-plugin-prettier": "^5.5.4",
+        "eslint-plugin-simple-import-sort": "^12.1.1",
+        "jsdoc": "^4.0.4",
+        "postcss": "^8.5.6",
+        "postcss-scss": "^4.0.9",
+        "prettier": "^2.2.1",
+        "stylelint": "^14.9.1",
+        "stylelint-config-prettier": "^9.0.3",
+        "stylelint-config-sass-guidelines": "^9.0.0",
+        "stylelint-config-standard": "^26.0.0",
+        "stylelint-order": "^5.0.0",
+        "stylelint-scss": "^4.2.0",
+        "uglify-js": "^3.16.0"
+    },
+    "dependencies": {
+        "@jsdoc/salty": "^0.2.4",
+        "fs-extra": "^10.1.0",
+        "html-minifier-terser": "^7.2.0",
+        "klaw-sync": "^6.0.0",
+        "lodash": "^4.17.21",
+        "showdown": "^2.1.0"
+    },
+    "packageManager": "yarn@4.9.3"
+}