web-documentation 1.0.0

package/package.json

@@ -0,0 +1,336 @@
+{
+  "name": "web-documentation",
+  "version": "1.0.0",
+  "description": "Declarative multilanguage documentation website generator",
+  "keywords": [
+    "documentation",
+    "website",
+    "homepage",
+    "page",
+    "project"
+  ],
+  "bugs": {
+    "email": "info@torben.website",
+    "url": "https://github.com/thaibault/wbe-documentation/issues"
+  },
+  "license": "CC-BY-3.0",
+  "author": {
+    "name": "Torben Sickert",
+    "email": "info@torben.website",
+    "url": "https://torben.website"
+  },
+  "files": [
+    "build/deploy.js",
+    "build/deploy.d.ts",
+    "source"
+  ],
+  "main": "source/index.html.ejs",
+  "bin": "build/deploy.js",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/thaibault/web-documentation"
+  },
+  "scripts": {
+    "build": "yarn build:web; yarn build:deploy",
+    "build:deploy": "weboptimizer build '{__reference__: \"target:deploy\"}'",
+    "build:web": "weboptimizer build",
+    "build:stats": "weboptimizer build --profile --json /tmp/stats.json | sed --regexp-extended 's/^Running \".+$//' | sed --regexp-extended 's/^Consolidate module request \".+$//' >/tmp/stats.json && echo 'Results successfully written to \"/tmp/stats.json\".'",
+    "check": "yarn check:types; yarn lint",
+    "check:types": "weboptimizer check:types",
+    "clear": "weboptimizer clear",
+    "document": "weboptimizer document",
+    "lint": "weboptimizer lint",
+    "prepareBACKUP": "yarn build",
+    "serve": "weboptimizer serve",
+    "start": "yarn serve",
+    "test": "yarn clear && weboptimizer test",
+    "test:browser": "yarn clear && weboptimizer test:browser",
+    "test:coverage": "yarn clear && weboptimizer test:coverage",
+    "test:coverage:report": "yarn clear && weboptimizer test:coverage:report",
+    "watch": "weboptimizer build --watch"
+  },
+  "devDependencies": {
+    "@aws-sdk/client-s3": "^3.1033.0",
+    "@babel/eslint-parser": "^7.28.6",
+    "@babel/runtime": "^7.29.2",
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/archiver": "^7.0.0",
+    "@types/ejs": "^3.1.5",
+    "@types/html-minifier": "^4.0.6",
+    "@types/jsdom": "^28.0.1",
+    "@types/marked": "^6.0.0",
+    "@types/node": "^25.6.0",
+    "@types/unzipper": "^0.10.11",
+    "@types/webpack-env": "^1.18.8",
+    "@typescript-eslint/eslint-plugin": "^8.59.0",
+    "@typescript-eslint/parser": "^8.59.0",
+    "@webcomponents/webcomponentsjs": "^2.8.0",
+    "archiver": "^7.0.1",
+    "clientnode": "^4.0.1387",
+    "css-loader": "^7.1.4",
+    "cssnano": "^7.1.7",
+    "default-gateway": "^7.2.2",
+    "errorreporter": "^1.0.338",
+    "eslint": "^10.2.1",
+    "eslint-config-google": "^0.14.0",
+    "eslint-plugin-jsdoc": "^62.9.0",
+    "favicons": "^7.2.0",
+    "favicons-webpack-plugin": "^6.0.1",
+    "highlight.js": "^11.11.1",
+    "jest": "^30.3.0",
+    "jsdoc": "^4.0.5",
+    "legal-notes": "^1.0.28",
+    "marked": "^18.0.2",
+    "marked-gfm-heading-id": "^4.1.4",
+    "marked-highlight": "^2.2.4",
+    "marked-xhtml": "^1.0.15",
+    "mini-css-extract-plugin": "^2.10.2",
+    "postcss": "^8.5.10",
+    "postcss-fontpath": "^1.0.0",
+    "postcss-import": "^16.1.1",
+    "postcss-loader": "^8.2.1",
+    "postcss-mixins": "^12.1.2",
+    "postcss-nested": "^7.0.2",
+    "postcss-preset-env": "^11.2.1",
+    "postcss-scss": "^4.0.9",
+    "postcss-sprites": "^4.2.1",
+    "postcss-url": "^10.1.3",
+    "prop-types": "^15.8.1",
+    "style-loader": "^4.0.0",
+    "stylelint": "^17.8.0",
+    "stylelint-config-standard": "^40.0.0",
+    "typescript-eslint": "^8.59.0",
+    "ua-parser-js": "^2.0.9",
+    "unzipper": "^0.12.3",
+    "web-component-wrapper": "^0.0.561",
+    "web-internationalization": "^2.0.7",
+    "weboptimizer": "^3.0.21",
+    "webpack-dev-server": "^5.2.3",
+    "website-utilities": "^1.0.385"
+  },
+  "engines": {
+    "node": ">=24",
+    "npm": ">=11",
+    "yarn": ">=4"
+  },
+  "resolutions": {
+    "colors": "1.4.0",
+    "globals@npm:^14.0.0": "patch:globals@npm%3A11.12.0#~/.yarn/patches/globals-npm-11.12.0-1fa7f41a6c.patch",
+    "globals@npm:^11.1.0": "patch:globals@npm%3A11.12.0#~/.yarn/patches/globals-npm-11.12.0-1fa7f41a6c.patch",
+    "globals@npm:^9.18.0": "patch:globals@npm%3A11.12.0#~/.yarn/patches/globals-npm-11.12.0-1fa7f41a6c.patch"
+  },
+  "sideEffects": true,
+  "webOptimizer": {
+    "build": {
+      "definitions": {
+        "TRACKING_CODE": {
+          "__evaluate__": "`'${self.module.preprocessor.html.options.locals.TRACKING_CODE}'`"
+        },
+        "LANGUAGES": {
+          "__evaluate__": "`['${self.module.preprocessor.html.options.locals.LANGUAGES.join(\"', '\")}']`"
+        }
+      }
+    },
+    "commandLine": {
+      "test": {
+        "environments": [
+          "jsdom"
+        ]
+      }
+    },
+    "injection": {
+      "chunks": false,
+      "entry": {
+        "#": "errorreporter\": [\"ua-parser-js\", \"errorreporter\"]",
+        "__evaluate__": "2 < self.givenCommandLineArguments.length && self.givenCommandLineArguments[2].startsWith('test') ? {testBundle: './test.ts'} : {index: ['./index.css', '@webcomponents/webcomponentsjs/webcomponents-bundle.js', '@webcomponents/webcomponentsjs/custom-elements-es5-adapter.js', './index']}"
+      }
+    },
+    "library": false,
+    "module": {
+      "enforceDeduplication": true,
+      "html": {
+        "options": {
+          "sources": {
+            "urlFilter": {
+              "__evaluate__": "() => false"
+            }
+          }
+        }
+      },
+      "optimizer": {
+        "babelMinify": {
+          "#": "To provide a logging output we need to exclude this feature.",
+          "bundle": {
+            "transform": {
+              "removeConsole": false
+            }
+          },
+          "#1": "Avoids wrong this binding in some callbacks with class bound closure (e.g. in \"performStartUpEffects -> animate -> always\".",
+          "module": null
+        },
+        "#": "We have to add disable \"mergeRules\" since it removes header link color over writing.",
+        "cssnano": {
+          "__evaluate__": "self.debug ? null : {preset: [optionalRequire('cssnano-preset-default'), {autoprefixer: false, discardUnused: !self.library, mergeRules: false}]}"
+        },
+        "htmlMinifier": {
+          "ignoreCustomComments": [
+            {
+              "__evaluate__": "/^\\|?[a-z]{2}[A-Z]{2}:/"
+            },
+            {
+              "__evaluate__": "/^[a-z]{2}[A-Z]{2}$/"
+            },
+            {
+              "__evaluate__": "/^showExample(?::[a-zA-Z]+)?$/"
+            }
+          ]
+        }
+      },
+      "preprocessor": {
+        "cascadingStyleSheet": {
+          "additional": {
+            "plugins": {
+              "pre": {
+                "__append__": [
+                  "require('postcss-mixins')",
+                  "require('postcss-nested')"
+                ]
+              }
+            }
+          }
+        },
+        "ejs": {
+          "options": {
+            "locals": {
+              "API_DOCUMENTATION_PATH": "/apiDocumentation/",
+              "CONTENT": "source/dummyReadme.md",
+              "DISTRIBUTION_BUNDLE_FILE_PATH": "dummyDistributionBundle.zip",
+              "LANGUAGES": {
+                "__evaluate__": "self.module.preprocessor.html.options.locals.NAME === 'web-documentation' ? ['enUS', 'deDE', 'frFR'] : ['enUS']"
+              },
+              "MARKED_OPTIONS": {
+                "#": "If true, add <br> on a single line break (copies GitHub behavior on comments, but not on rendered markdown files). Requires gfm be true.",
+                "breaks": false,
+                "#1": "If true, use approved GitHub Flavored Markdown (GFM) specification.",
+                "gfm": true,
+                "#2": "If true, conform to the original markdown.pl as much as possible. Don't fix original markdown bugs or behavior. Turns off and overrides gfm.",
+                "pedantic": false,
+                "#3": "If true, the parser does not throw any exception.",
+                "silent": false
+              },
+              "NAME": "web-documentation",
+              "IS_DIRECTORY": {
+                "__evaluate__": "filesystem.isDirectorySync"
+              },
+              "READ_FILE": {
+                "__evaluate__": "fs.readFileSync"
+              },
+              "RENDER_MARKDOWN": {
+                "__evaluate__": "require(path.resolve(currentPath, 'source/renderMarkdown.mjs')).default(self.module.preprocessor.ejs.options.locals.MARKED_OPTIONS)"
+              },
+              "META_TAGS": [],
+              "SOURCE_URL": {
+                "__evaluate__": "`https://github.com/thaibault/${self.module.preprocessor.html.options.locals.NAME}`"
+              },
+              "TAGLINE": "generic documentation website pattern",
+              "URL": {
+                "__evaluate__": "`https://torben.website/${self.module.preprocessor.html.options.locals.NAME}`"
+              }
+            }
+          }
+        }
+      }
+    },
+    "path": {
+      "source": {
+        "asset": {
+          "cascadingStyleSheet": "./",
+          "javaScript": "./"
+        }
+      },
+      "target": {
+        "asset": {
+          "cascadingStyleSheet": "./",
+          "javaScript": "./"
+        }
+      }
+    },
+    "target:debug": {
+      "module": {
+        "optimizer": {
+          "cssnano": null
+        }
+      }
+    },
+    "target:deploy": {
+      "assetPattern": {
+        "javaScript": {
+          "pattern": {
+            "#": "This is how we can make our main exported artefact executable.",
+            "__evaluate__": "`#!/usr/bin/env node\n// -*- coding: utf-8 -*-\n${self.generic.assetPattern.javaScript.pattern}{1}`"
+          }
+        }
+      },
+      "exportFormat": {
+        "external": "commonjs2",
+        "self": "commonjs2"
+      },
+      "files": {
+        "defaultHTML": {
+          "template": {
+            "filePath": "none"
+          }
+        }
+      },
+      "injection": {
+        "entry": {
+          "__evaluate__": "2 < self.givenCommandLineArguments.length && self.givenCommandLineArguments[2].startsWith('test') ? {testBundle: './test.ts'} : {deploy: './deploy'}"
+        }
+      },
+      "module": {
+        "optimizer": {
+          "babelMinify": {
+            "#": "To provide a logging output we need to exclude this feature.",
+            "bundle": {
+              "transform": {
+                "removeConsole": false
+              }
+            },
+            "module": {
+              "removeConsole": false
+            }
+          }
+        }
+      },
+      "targetTechnology": {
+        "boilerplate": "node",
+        "payload": "node"
+      }
+    },
+    "webpack": {
+      "snapshot": {
+        "unmanagedPaths": [
+          {
+            "__evaluate__": "/^.+?[\\/]node_modules[\\/]clientnode[\\/]/"
+          },
+          {
+            "__evaluate__": "/^.+?[\\/]node_modules[\\/]web-component-wrapper[\\/]/"
+          },
+          {
+            "__evaluate__": "/^.+?[\\/]node_modules[\\/]web-internationalization[\\/]/"
+          },
+          {
+            "__evaluate__": "/^.+?[\\/]node_modules[\\/]website-utilities[\\/]/"
+          }
+        ]
+      },
+      "watchOptions": {
+        "ignored": {
+          "__remove__": "**/node_modules"
+        }
+      }
+    }
+  },
+  "packageManager": "yarn@4.12.0+sha512.f45ab632439a67f8bc759bf32ead036a1f413287b9042726b7cc4818b7b49e14e9423ba49b18f9e06ea4941c1ad062385b1d8760a8d5091a1a31e5f6219afca8"
+}

package/readme.md

@@ -0,0 +1,37 @@
+<!-- !/usr/bin/env markdown
+-*- coding: utf-8 -*-
+region header
+Copyright Torben Sickert (info["~at~"]torben.website) 16.12.2012
+
+License
+-------
+
+This library written by Torben Sickert stand under a creative commons naming
+3.0 unported license. See https://creativecommons.org/licenses/by/3.0/deed.de
+endregion -->
+
+Project status
+--------------
+
+[![npm](https://img.shields.io/npm/v/web-documentation?color=%23d55e5d&label=npm%20package%20version&logoColor=%23d55e5d&style=for-the-badge)](https://www.npmjs.com/package/web-documentation)
+[![npm downloads](https://img.shields.io/npm/dy/web-documentation.svg?style=for-the-badge)](https://www.npmjs.com/package/web-documentation)
+
+[![build](https://img.shields.io/github/actions/workflow/status/thaibault/web-documentation/build.yaml?style=for-the-badge)](https://github.com/thaibault/web-documentation/actions/workflows/build.yaml)
+[![build push package](https://img.shields.io/github/actions/workflow/status/thaibault/web-documentation/build-package-and-push.yaml?label=build%20push%20package&style=for-the-badge)](https://github.com/thaibault/web-documentation/actions/workflows/build-package-and-push.yaml)
+
+[![check types](https://img.shields.io/github/actions/workflow/status/thaibault/web-documentation/check-types.yaml?label=check%20types&style=for-the-badge)](https://github.com/thaibault/web-documentation/actions/workflows/check-types.yaml)
+[![lint](https://img.shields.io/github/actions/workflow/status/thaibault/web-documentation/lint.yaml?label=lint&style=for-the-badge)](https://github.com/thaibault/web-documentation/actions/workflows/lint.yaml)
+[![test](https://img.shields.io/github/actions/workflow/status/thaibault/web-documentation/test-coverage-report.yaml?label=test&style=for-the-badge)](https://github.com/thaibault/web-documentation/actions/workflows/test-coverage-report.yaml)
+
+[![code coverage](https://img.shields.io/coverallsCoverage/github/thaibault/web-documentation?label=code%20coverage&style=for-the-badge)](https://coveralls.io/github/thaibault/web-documentation)
+
+Use case
+--------
+
+This is my central development for all of my documentation or project
+presentation web pages.
+
+Included Features:
+
+- Auto-building API-Documentation
+- Auto-building Presentation Website