docs: initialize docusaurus

.github/workflows/deploy_docusaurus.yml

@@ -0,0 +1,66 @@
+#
+# This workflow is based on the example workflow from the docusaurus documentation:
+# https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions
+# The Docusaurus documentation is licensed under the CC-BY-4.0 license. See
+# https://github.com/facebook/docusaurus/blob/6c7f2fde20b2448a1b966dd5f674205c0a08eeba/LICENSE-docs
+# for more information.
+#
+
+name: "Deploy: Docusaurus Documentation"
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  build-docusaurus:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: './docs/package-lock.json'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+      - name: Build website
+        run: yarn build
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs/build
+
+  deploy-docusaurus:
+    name: Deploy to GitHub Pages
+    needs: build-docusaurus
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/watermarker_docs.yml → .github/workflows/deploy_watermarker-source-code-docs.yml

@@ -5,12 +5,10 @@
 # that can be found in the LICENSE file.
 #
 
-name: "Watermarker: Generate API docs"
+name: "Deploy: Watermarker API docs"
 
 on:
-  push:
-    branches:
-      - main
+  workflow_dispatch:
 
 permissions:
   contents: write

.github/workflows/test_cli.yml

@@ -5,7 +5,7 @@
 # that can be found in the LICENSE file.
 #
 
-name: "CLI: Test"
+name: "Test: CLI"
 
 on:
   push:

.github/workflows/test_docusaurus.yml

@@ -0,0 +1,39 @@
+#
+# This workflow is based on the example workflow from the docusaurus documentation:
+# https://docusaurus.io/docs/deployment#triggering-deployment-with-github-actions
+# The Docusaurus documentation is licensed under the CC-BY-4.0 license. See
+# https://github.com/facebook/docusaurus/blob/6c7f2fde20b2448a1b966dd5f674205c0a08eeba/LICENSE-docs
+# for more information.
+#
+
+name: "Test: Docusaurus Documentation Deployment"
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test-deploy-docusaurus:
+    name: Test deployment
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        working-directory: ./docs
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: yarn
+          cache-dependency-path: './docs/package-lock.json'
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Test build website
+        run: yarn build

.github/workflows/test_watermarker.yml

@@ -5,7 +5,7 @@
 # that can be found in the LICENSE file.
 #
 
-name: "Watermarker: Test"
+name: "Test: Watermarker"
 
 on:
   push:

.github/workflows/test_webinterface.yml

@@ -5,7 +5,7 @@
 # that can be found in the LICENSE file.
 #
 
-name: "Webinterface: Test"
+name: "Test: Webinterface"
 
 on:
   push:

.gitignore

@@ -1,4 +1,11 @@
-# Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,gradle,maven,kotlin,java,git
+#
+# Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+#
+# This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+# that can be found in the LICENSE file.
+#
+# The initial version of this file was created by .gitignore from Toptal.
+# See https://www.toptal.com/developers/gitignore/api/intellij+iml,gradle,maven,kotlin,java,git
 # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,gradle,maven,kotlin,java,git
 
 ### Git ###

NOTICE.md

@@ -23,10 +23,26 @@ information.
 
 There are third-party content used by and shipped with this project with different licenses.
 
-This project uses Gradle and the Gradle Wrapper
+### Gradle & Gradle Wrapper
+This project uses Gradle and the Gradle Wrapper.
 - GitHub project: https://github.com/gradle/gradle
 - License: [Apache-2.0 license](https://github.com/gradle/gradle/blob/master/LICENSE)
 
+### unDraw Illustrations
+This project uses illustrations from unDraw.
+- Source URL: https://undraw.co/illustrations
+- License: https://undraw.co/license
+
+### Docusaurus
+The documentation uses the Docusaurus framework with its autogenerated files.
+- GitHub project: https://github.com/facebook/docusaurus
+- License (code): [MIT license](https://github.com/facebook/docusaurus/blob/main/LICENSE)
+- License (documentation): [CC-BY-4.0](https://github.com/facebook/docusaurus/blob/main/LICENSE-docs)
+
+### Dependencies
+This project uses different dependencies. See the specific subfolders of each component for more
+information.
+
 ## Source Code
 
 The source code is located in the following GitHub project: https://github.com/FraunhoferISST/TREND

docs/.gitignore

@@ -0,0 +1,31 @@
+#
+# Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+#
+# This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+# that can be found in the LICENSE file.
+#
+# The initial version of this file was auto-generated by Docusaurus. Docusaurus is published under
+# the MIT license.
+# See https://github.com/facebook/docusaurus/blob/main/LICENSE for more information.
+#
+
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,40 @@
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+
+ The initial version of this file was auto-generated by Docusaurus. Docusaurus is published under
+ the MIT license.
+ See https://github.com/facebook/docusaurus/blob/main/LICENSE for more information.
+-->
+
+# Documentation
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. The local deployment is published at http://localhost:3000/.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+On every commit on the main branch, the documentation is automatically updated by an automated deployment.

docs/babel.config.js

@@ -0,0 +1,13 @@
+/*
+ * Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+ *
+ * This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ * that can be found in the LICENSE file.
+ *
+ * The initial version of this file was auto-generated by Docusaurus. Docusaurus is published under
+ * the MIT license.
+ * See https://github.com/facebook/docusaurus/blob/main/LICENSE for more information.
+ */
+module.exports = {
+  presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
+};

docs/Trendmark.md → docs/docs/Trendmark.md

@@ -1,3 +1,10 @@
+<!--
+ Copyright (c) 2024 Fraunhofer-Gesellschaft zur Förderung der angewandten Forschung e.V.
+
+ This work is licensed under the Fraunhofer License (on the basis of the MIT license)
+ that can be found in the LICENSE file.
+-->
+
 # Trendmark
 The watermarker library uses bytes as the watermark content. This approach is very flexible and
 allows almost any content to be inserted as a watermark. However, when extracting a watermark, it is