initial commit

wendevlin · Apr 29, 2024 · c1dadf8 · c1dadf8
1 parent 2a50325
commit c1dadf8
Show file tree

Hide file tree

Showing 58 changed files with 917 additions and 229 deletions.
diff --git a/.devcontainer.json b/.devcontainer.json
diff --git a/.vscode/tasks.json b/.vscode/tasks.json
diff --git a/README.md b/README.md
@@ -1,24 +1,20 @@
-# Example Home Assistant add-on repository
+# Home Assistant Homedocs add-on repository
 
-This repository can be used as a "blueprint" for add-on development to help you get started.
-
-Add-on documentation: <https://developers.home-assistant.io/docs/add-ons>
-
-[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fhome-assistant%2Faddons-example)
+[![Open your Home Assistant instance and show the add add-on repository dialog with a specific repository URL pre-filled.](https://my.home-assistant.io/badges/supervisor_add_addon_repository.svg)](https://my.home-assistant.io/redirect/supervisor_add_addon_repository/?repository_url=https%3A%2F%2Fgithub.com%2Fmasterwendu%2Fhomeassistant-addons)
 
 ## Add-ons
 
 This repository contains the following add-ons
 
-### [Example add-on](./example)
+### [HomeDocs](./homedocs)
 
 ![Supports aarch64 Architecture][aarch64-shield]
 ![Supports amd64 Architecture][amd64-shield]
 ![Supports armhf Architecture][armhf-shield]
 ![Supports armv7 Architecture][armv7-shield]
 ![Supports i386 Architecture][i386-shield]
 
-_Example add-on to use as a blueprint for new add-ons._
+_Document stuff with Markdown based on Astro Starlight_
 
 <!--
 

diff --git a/example/CHANGELOG.md b/example/CHANGELOG.md
diff --git a/example/DOCS.md b/example/DOCS.md
diff --git a/example/Dockerfile b/example/Dockerfile
diff --git a/example/README.md b/example/README.md
diff --git a/example/apparmor.txt b/example/apparmor.txt
diff --git a/example/config.yaml b/example/config.yaml
diff --git a/example/icon.png b/example/icon.png
diff --git a/example/logo.png b/example/logo.png
diff --git a/example/rootfs/etc/services.d/example/finish b/example/rootfs/etc/services.d/example/finish
diff --git a/example/rootfs/etc/services.d/example/run b/example/rootfs/etc/services.d/example/run
diff --git a/example/rootfs/usr/bin/my_program b/example/rootfs/usr/bin/my_program
diff --git a/example/translations/en.yaml b/example/translations/en.yaml
diff --git a/homedocs/.mise.toml b/homedocs/.mise.toml
@@ -0,0 +1,3 @@
+[tools]
+node = "20"
+bun = "1.1.6"
diff --git a/homedocs/CHANGELOG.md b/homedocs/CHANGELOG.md
@@ -0,0 +1,5 @@
+<!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
+
+## 1.0.0
+
+- Initial release
diff --git a/homedocs/DOCS.md b/homedocs/DOCS.md
@@ -0,0 +1,25 @@
+# Home Assistant Add-on: Homedocs
+
+This addon helps you document stuff around your home inside home assistant in a nice way.
+
+## How to use
+
+1. Install the addon
+2. Start the addon
+3. the addon creates a folder called `homedocs` in your config folder
+4. the addon copies some sample data to this folder
+5. edit the markdown files in the `homedocs` folder
+  - in the `content/docs` folder you can write your documentation
+  - all images should be placed in the `assets` folder
+    - the will be automatically optimized by astro
+6. The addon will recognize the changes and build the site after a give timeout (60 seconds is default)
+  - the timeout is needed because the build takes some time and can just runs once in parallel.
+7. open the webui to see your beautiful documentation
+
+### how to edit the documentation
+
+The documentation lies in your `config` directory under `homedocs`. When you edit or add/remove the markdown files, your changes will be build after the build timeout and you will see the changes inside the webui.
+
+#### Use the Studio Code Server addon
+
+I recommend to use the [Studio Code Server](https://github.com/hassio-addons/addon-vscode) to edit your documentation, because it is very convenient to edit markdown files with it and you can just drag and drop files into the addon.
diff --git a/homedocs/Dockerfile b/homedocs/Dockerfile
@@ -0,0 +1,43 @@
+ARG BUILD_FROM
+FROM $BUILD_FROM
+
+# Install requirements for add-on
+RUN apk add --update --no-cache nodejs npm bash ca-certificates wget
+# Install glibc to run Bun
+RUN if [[ $(uname -m) == "aarch64" ]] ; \
+    then \
+    # aarch64
+    wget https://raw.githubusercontent.com/squishyu/alpine-pkg-glibc-aarch64-bin/master/glibc-2.26-r1.apk ; \
+    apk add --no-cache --allow-untrusted --force-overwrite glibc-2.26-r1.apk ; \
+    rm glibc-2.26-r1.apk ; \
+    else \
+    # x86_64
+    wget https://github.com/sgerrand/alpine-pkg-glibc/releases/download/2.28-r0/glibc-2.28-r0.apk ; \
+    wget -q -O /etc/apk/keys/sgerrand.rsa.pub https://alpine-pkgs.sgerrand.com/sgerrand.rsa.pub ; \
+    apk add --no-cache --force-overwrite glibc-2.28-r0.apk ; \
+    rm glibc-2.28-r0.apk ; \
+    fi
+
+# Install Bun
+RUN npm install -g bun
+
+# Copy starlight data
+COPY starlight /starlight
+WORKDIR /starlight
+RUN bun install
+
+# copy and setup webserver
+COPY webserver/dist/index.js /webserver/index.js
+COPY webserver/src/templates /webserver/templates
+RUN mkdir -p /webserver/public
+
+# copy and setup run script
+COPY run.sh /
+RUN chmod a+x /run.sh
+
+# Disable astro telemetry
+RUN bunx astro telemetry disable
+
+WORKDIR /webserver
+
+CMD [ "/run.sh" ]