finish v2.0.0

wendevlin · May 29, 2024 · 27e5b0e · 27e5b0e
1 parent 5fe6ed2
commit 27e5b0e
Show file tree

Hide file tree

Showing 31 changed files with 73 additions and 153 deletions.
diff --git a/homedocs/CHANGELOG.md b/homedocs/CHANGELOG.md
@@ -1,5 +1,11 @@
 <!-- https://developers.home-assistant.io/docs/add-ons/presentation#keeping-a-changelog -->
 
+## 2.0.0
+
+- **BREAKING** The /config/homedocs directory doesn't need the content/docs, assets and files folder anymore. All content is now directly in the /config/homedocs folder.
+- Homedocs rewritten without astro. Uses now an elysia webserver and markdown-it for rendering markdown.
+- **BREAKING** Config changed and internal ports changed. I recommend to uninstall and reinstall the addon. Your markdown data will be kept in the home assistant config folder.
+
 ## 1.0.9
 
 - Fix webserver to use correct base url

diff --git a/homedocs/Dockerfile b/homedocs/Dockerfile
@@ -25,6 +25,9 @@ RUN npm install -g bun
 COPY server /server
 WORKDIR /server
 
+RUN bun install
+RUN bun run build
+
 # copy and setup run script
 COPY run.sh /
 RUN chmod a+x /run.sh

diff --git a/homedocs/README.md b/homedocs/README.md
@@ -1,26 +1,17 @@
 # Homedocs
 
 With this home assistant addon you can easily create a documentation site for your home or something else.
-It uses Starlight from astro under the hood.
 
 __Why homedocs__
 - Create a documentation site for your home and everything else
 - Auth with home assistant
 - Fast to create with markdown
 
-__Why starlight?__
-
-- Very good docs layout
-- markdown and MDX support
-- integrated search
-- images are automatically optimized
-- mobile optimized
-- dark mode
-
 __How I use it__:
 
 I document stuff that I don't need very often, for example a yearly maintainance of the heating.
 Moreover I printed QR codes on some devices, that you can fast access the documentation.
+In my docs I also store all manual files, so I have everything in one place.
 
 I have multiple documentation sites for:
 - garden
@@ -41,30 +32,19 @@ I have multiple documentation sites for:
 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.
+6. The addon will recognize the changes and build the site
 7. open the webui to see your beautiful documentation
+8. (optional) you can open it outside of your home assistant if you have the port configured
 
 ## Troubleshooting
 
 ### Build is not triggered
 
 I had sometimes the issue that the build wasn't triggert, if this happens you can restart your addon, then the build will be triggert on startup.
 
-## Check the logs!
-
-If your made a mistake in your markdown files the build will fail, check the logs for more information. Starlight will give you a hint on what went wrong.
-You won't see the error in the browser, it will still display the last version.
-
 ## Roadmap
 
-- [ ] Build information in frontend
-  - I could add custom web path for build information or it will be displayed on every page as some kind of overlay
-- [ ] Themes
-  - Starlight has a built in theme feature, I could provide some predefined themes to select from and the possibility to create custom themes
-  - Moreover I could get the home assistant theme and use this base colors
-- [ ] hot reload
-  - Starlight is working on SSR, maybe it is then possible to have hot reload instead of the full build
+- [ ] Image optimization
+- [ ] More efficient build
+- [ ] Integrated search
+- [ ] Table of contents
diff --git a/homedocs/archive/docs/guides/example.md b/homedocs/archive/docs/guides/example.md
diff --git a/homedocs/archive/docs/index.mdx b/homedocs/archive/docs/index.mdx
diff --git a/homedocs/archive/docs/reference/example.md b/homedocs/archive/docs/reference/example.md
diff --git a/homedocs/config.yaml b/homedocs/config.yaml
@@ -1,6 +1,6 @@
 name: Homedocs
 description: Document stuff with Markdown
-version: "2.0.0-beta.1"
+version: "2.0.0"
 slug: homedocs
 init: false
 url: https://github.com/masterwendu/homeassistant-addons/tree/main/homedocs
@@ -21,4 +21,4 @@ ports_description:
   3000/tcp: Web interface (Not required for Ingress)
 panel_icon: mdi:text-box-outline
 panel_admin: false
-image: "ghcr.io/masterwendu/{arch}-addon-homedocs"
+# image: "ghcr.io/masterwendu/{arch}-addon-homedocs"
diff --git a/homedocs/run.sh b/homedocs/run.sh
@@ -6,7 +6,7 @@ if [ -z "$(ls -A /config/homedocs)" ]; then
     echo "created /config/homedocs directory."
 
     # copy the example contents of the "/starlight/src/content/docs" directory to the "/config/homedocs" directory.
-    cp -r /server/docs /config/homedocs
+    cp -r /server/docs/* /config/homedocs
     echo "copied example content to /config/homedocs."
 else
     echo "/config/homedocs is not empty, skipping copy example content."
@@ -19,4 +19,4 @@ fi
 # BUILD_TIMEOUT_IN_SECONDS=$(bashio::config 'buildTimeoutInSeconds')
 
 # start the webserver
-NODE_ENV=production DOCS_BASE_PATH=/config/homedocs bun run start:production
+DOCS_BASE_PATH=/config/homedocs bun run start:production
diff --git a/homedocs/server/bun.lockb b/homedocs/server/bun.lockb
diff --git a/homedocs/server/docs/Downloads/index.md b/homedocs/server/docs/Downloads/index.md
@@ -0,0 +1,7 @@
+If you want to save for example some manuals you can create download links with the HTML syntax:
+
+```html
+<a href="../files/sample.pdf" download>here</a>
+```
+
+Download the file <a href="../files/sample.pdf" download>here</a>
diff --git a/homedocs/server/docs/Folder/hierarchy/file.md b/homedocs/server/docs/Folder/hierarchy/file.md
@@ -0,0 +1,7 @@
+# File in folder
+
+I am a markdown file:
+
+- 1. One
+- 2. Two
+- 3. Three
diff --git a/homedocs/server/docs/Folder/hierarchy/index.md b/homedocs/server/docs/Folder/hierarchy/index.md
@@ -0,0 +1,8 @@
+---
+
+title: Subfolder
+
+---
+
+
+This is a index file in a subfolder of a folder, with a defined title so the subfolder name will be overwritten.
diff --git a/homedocs/server/docs/amazing/spiderman.md b/homedocs/server/docs/amazing/spiderman.md
diff --git a/homedocs/server/docs/amazing/venom/description.md b/homedocs/server/docs/amazing/venom/description.md
diff --git a/homedocs/server/docs/amazing/venom/index.md b/homedocs/server/docs/amazing/venom/index.md
diff --git a/homedocs/server/docs/files/sample.pdf b/homedocs/server/docs/files/sample.pdf
diff --git a/homedocs/server/docs/hellooo.md b/homedocs/server/docs/hellooo.md
diff --git a/homedocs/server/docs/images/Home-Docs.png b/homedocs/server/docs/images/Home-Docs.png
diff --git a/homedocs/server/docs/index.md b/homedocs/server/docs/index.md
@@ -1,8 +1,13 @@
 ---
-title: Test
-uga: Affe
+title: Welcome to Homedocs
 ---
 
-# this is the main woodhome
+![](./images/Home-Docs.png)
 
-hallloo oida?
+## Congrats on setting up a new Homedocs project!
+
+Your documentation files are located in the homedocs folder inside your home assistant configuration.
+
+## Get started writing your homedocs!
+
+![](./images/documentation.gif)
diff --git a/homedocs/server/docs/my/index.md b/homedocs/server/docs/my/index.md
diff --git a/homedocs/server/docs/my/uga/affe.md b/homedocs/server/docs/my/uga/affe.md
diff --git a/homedocs/server/docs/test/test/test/test/index.md b/homedocs/server/docs/test/test/test/test/index.md
diff --git a/homedocs/server/docs/test/test/test/test/test.md b/homedocs/server/docs/test/test/test/test/test.md
diff --git a/homedocs/server/package.json b/homedocs/server/package.json
@@ -14,7 +14,6 @@
     "chokidar": "3.6.0",
     "elysia": "1.0.22",
     "glob": "10.4.1",
-    "logestic": "1.2.0",
     "markdown-it": "14.1.0",
     "markdown-it-emoji": "3.0.0",
     "zod": "3.23.8"

diff --git a/homedocs/server/scripts/build.ts b/homedocs/server/scripts/build.ts
@@ -1,4 +1,4 @@
-import { build } from "bun"
+// import { build } from "bun"
 import { buildCss } from "./tailwind"
 
 // build css with tailwind and daisyui
@@ -7,10 +7,11 @@ await buildCss()
 console.log('CSS build finished ✓')
 
 // build the server
-await Bun.build({
-  entrypoints: ['./src/index.ts'],
-  outdir: './dist',
-  target: 'bun',
-})
+// TODO use optimized bun build
+// await Bun.build({
+//   entrypoints: ['./src/index.ts'],
+//   outdir: './dist',
+//   target: 'bun',
+// })
 
 console.log('Server build finished ✓')
diff --git a/homedocs/server/src/htmlBuilder/navigation.ts b/homedocs/server/src/htmlBuilder/navigation.ts
@@ -25,14 +25,14 @@ export const generateNavForFolder = async (
 				)
 				if (index > -1) {
 					const indexChild = children[index]
-					// const { title, content } = await parseFile(`${folder}/${fileOrFolder}/index.md`, fileOrFolder)
 
 					const path = indexChild.path!
 
 					children.splice(index, 1)
 
 					level.push({
-						title: indexChild.title ?? fileOrFolder,
+						title:
+							indexChild.title !== 'index' ? indexChild.title : fileOrFolder,
 						path,
 						children,
 						htmlContent: indexChild.htmlContent,

diff --git a/homedocs/server/src/markdown/frontMatterPlugin.ts b/homedocs/server/src/markdown/frontMatterPlugin.ts
@@ -50,7 +50,7 @@ export const frontMatterPlugin = (md: MarkdownIt) => {
 		// while pos <= 3
 		let start = state.bMarks[startLine] + state.tShift[startLine]
 		let max = state.eMarks[startLine]
-		let start_content: number
+		let start_content = 0
 		let pos: number
 		for (pos = start + 1; pos <= max; pos++) {
 			if (marker_str[(pos - start) % marker_len] !== state.src[pos]) {
@@ -155,7 +155,6 @@ export const frontMatterPlugin = (md: MarkdownIt) => {
 			for (const line of token.meta.split('\n')) {
 				const [key = '', value = ''] = line.split(':')
 				if (key && value) {
-					console.log('frontmatter', key, value)
 					frontMatterObject[key.trim()] = value.trim()
 				}
 			}

diff --git a/homedocs/server/src/markdown/markdownParser.ts b/homedocs/server/src/markdown/markdownParser.ts
@@ -11,6 +11,7 @@ export interface MarkdownIt extends Markdownit {
 
 const md = markdownit({
 	linkify: true,
+	html: true,
 })
 	.use(emoji)
 	.use(frontMatterPlugin) as MarkdownIt
@@ -39,5 +40,3 @@ export const parseFile = async (filePath: string, filename: string) => {
 		content: htmlContent,
 	}
 }
-
-await parseFile('./docs/my/index.md', 'my')
diff --git a/homedocs/server/src/templates/layout.tsx b/homedocs/server/src/templates/layout.tsx
@@ -6,7 +6,7 @@ export default (
 ) => (
 	<html lang="en">
 		<head>
-			<title>{title}</title>
+			<title>Homedocs</title>
 			<meta charset="utf-8" />
 			<meta name="viewport" content="width=device-width, initial-scale=1" />
 			<link rel="stylesheet" href="./main.css" />

diff --git a/homedocs/server/src/templates/navigation.tsx b/homedocs/server/src/templates/navigation.tsx
@@ -11,7 +11,7 @@ const subNavigation = (
 				{path === undefined ? (
 					<span class="hover:bg-nav dark:hover:bg-nav-dark hover:cursor-default">
 						<svg
-							class="w-4 -ml-1 -mr-1"
+							class="w-4 -ml-1 -mr-1 dark:fill-white"
 							aria-hidden="true"
 							viewBox="-43.52 -43.52 599.04 599.04"
 						>