From 7f2602e8968f3c6f4a31bb49880b911cc22174e6 Mon Sep 17 00:00:00 2001 From: ZanzyTHEbar Date: Sun, 15 Jan 2023 06:28:05 +0000 Subject: [PATCH] update: update Alerts to support custom html content --- .../docs/src/pages/getting_started/intro.md | 17 +++++- .../docs/src/pages/how_to_build/parts_list.md | 52 ++++++++++++++++--- vitepress/docs/src/static/alerts/index.ts | 14 ++--- vitepress/docs/src/vue/alerts/Alerts.vue | 8 ++- 4 files changed, 70 insertions(+), 21 deletions(-) diff --git a/vitepress/docs/src/pages/getting_started/intro.md b/vitepress/docs/src/pages/getting_started/intro.md index e640d17..694c7d4 100644 --- a/vitepress/docs/src/pages/getting_started/intro.md +++ b/vitepress/docs/src/pages/getting_started/intro.md @@ -7,7 +7,14 @@ import { alerts } from '../../static/alerts' Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol. - + + + ## Hardware @@ -24,7 +31,13 @@ When files and resources are released **DO NOT BYPASS (OR NOT DO) ANY SAFET The safety measures were put in place to REDUCE the potential failure risk. All further safety responsibilities are on the user. This includes visually checking with an IR camera that the brightness is correct and that you do not feel warmth or experience short-term effects after being exposed to the IR light (symptoms such as dark spots or dry/warm feeling eyes while actively using). While we strive to make EyeTrackVR as safe as possible, we do not hold any responsibility for damage done. - + + + [Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf) diff --git a/vitepress/docs/src/pages/how_to_build/parts_list.md b/vitepress/docs/src/pages/how_to_build/parts_list.md index 88d10cb..dc62340 100644 --- a/vitepress/docs/src/pages/how_to_build/parts_list.md +++ b/vitepress/docs/src/pages/how_to_build/parts_list.md @@ -6,13 +6,33 @@ import PartsList from '../../vue/parts_list/PartsList.vue' # Parts List {.text-[#ab5ac7]} + + + + ## This page will include a basic part list for building an EyeTrackVR setup - + + + - +--- - + + + ## Camera setup @@ -42,9 +62,23 @@ Reccommended: - 4x Unfocused SMD IR emitters Recomended ones [from LCSC here](https://www.lcsc.com/product-detail/Infrared-IR-LEDs_XINGLIGHT-XL-3216HIRC-850_C965891.html). Alternative ones [from Digikey here](https://www.digikey.com/en/products/detail/inolux/IN-P32ZTIR/10384796). The difference between them is the ones from LCSC are rated for lower power, which means in the event of a short or mishap they should be safer, hence why they are recommended. - + + + - + + + - 4x IR emitter PCBs (highly recommended) Gerber files and schematics located [here.](https://github.com/RedHawk989/EyeTrackVR-Hardware/tree/main/IR%20Emmitter) @@ -79,4 +113,10 @@ If you own another headset not listed above, that means there are no mounts desi Check out our basic guide on making your own mount [here.](https://docs.eyetrackvr.dev/creating_your_own_camera_mount/) - + + + diff --git a/vitepress/docs/src/static/alerts/index.ts b/vitepress/docs/src/static/alerts/index.ts index 883b20d..9c24021 100644 --- a/vitepress/docs/src/static/alerts/index.ts +++ b/vitepress/docs/src/static/alerts/index.ts @@ -4,16 +4,14 @@ const alerts = { title: '', title_color: 'text-[orange]', text_color: 'text-slate-500 dark:text-slate-400', - badge_content: 'CAUTION', - content: 'This project is in active development. However, it is working for most users', + badge_content: 'CAUTION' }, led_power_warning: { type: 'danger', title: 'Please pay attention', - title_color: 'text-[red]', + title_color: 'text-red-400 dark:text-red-500', text_color: 'text-orange-400 dark:text-orange-500', - badge_content: 'WARNING', - content: 'Make sure you are using non-focused emitters and at around 5ma total power', + badge_content: 'WARNING' }, parts_list_one: { type: 'warning', @@ -21,7 +19,6 @@ const alerts = { title_color: 'text-[orange]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'CAUTION', - content: 'Please note that no hardware has been fully set in stone, all purchases are at your loss if hardware changes', }, parts_list_two: { type: 'info', @@ -29,7 +26,6 @@ const alerts = { title_color: 'text-[blue]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'NOTE', - content: 'It is recommended to source main parts from AliExpress as it is much cheaper.', }, parts_list_three: { type: 'info', @@ -37,7 +33,6 @@ const alerts = { title_color: 'text-[blue]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'NOTE', - content: 'It is good practice to buy more than needed in some cases, namely programmers and ESPs, this reduces the risk of a DOA (dead on arrival) causing a delay.', }, parts_list_four: { type: 'info', @@ -45,7 +40,6 @@ const alerts = { title_color: 'text-[blue]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'NOTE', - content: 'The smaller ones can not be soldered at temps above 245C or they will burn. Low temp solder is recommended', }, parts_list_five: { type: 'warning', @@ -53,7 +47,6 @@ const alerts = { title_color: 'text-[orange]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'CAUTION', - content: '(DO NOT BUY FOCUSED ONES! If they look like something you would find in a TV remote do not use them, if you aren\'t exactly sure what you are doing, buy them from the LCSC or Digikey link)', }, parts_list_six: { type: 'tip', @@ -61,7 +54,6 @@ const alerts = { title_color: 'text-[green]', text_color: 'text-slate-500 dark:text-slate-400', badge_content: 'TIP', - content: 'If you have a headset mount that is not listed above, please let us know in the discord so it can be added here', }, } diff --git a/vitepress/docs/src/vue/alerts/Alerts.vue b/vitepress/docs/src/vue/alerts/Alerts.vue index 03e9cfa..97195bf 100644 --- a/vitepress/docs/src/vue/alerts/Alerts.vue +++ b/vitepress/docs/src/vue/alerts/Alerts.vue @@ -9,7 +9,11 @@ const props = defineProps(['options']); -
{{ options.title }}
-

{{ options.content }}

+
+ {{ options.title }} +
+

+ +

\ No newline at end of file