begin migration to vitepress

This commit is contained in:
ZanzyTHEbar 2023-01-06 17:18:05 +00:00
parent 0a4e229a7e
commit ed6648a6e3
17 changed files with 11134 additions and 0 deletions

View File

@ -0,0 +1,15 @@
{
"plugins": {
"tailwindcss": {},
"postcss-flexbugs-fixes": {},
"postcss-preset-env": {
"autoprefixer": {
"flexbox": "no-2009"
},
"features": {
"custom-properties": false
},
"stage": 3
}
}
}

View File

@ -0,0 +1,13 @@
{
"hash": "6f388531",
"browserHash": "48962f0e",
"optimized": {
"vue": {
"src": "../../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "a6dbb0ab",
"needsInterop": false
}
},
"chunks": {}
}

View File

@ -0,0 +1 @@
{"type":"module"}

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,24 @@
// .vitepress/config.ts
import { defineConfigWithTheme } from 'vitepress'
import { theme, ThemeConfig } from '../src/custom/theme'
export default defineConfigWithTheme<ThemeConfig>({
outDir: '../dist',
srcDir: './src/pages',
//cleanUrls: 'with-subfolders',
head: [
[
'link',
{ rel: 'preconnect', href: 'https://fonts.gstatic.com', crossorigin: '' }
]
// would render: <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
],
markdown: {
//theme: 'material-palenight',
lineNumbers: true
},
lastUpdated: true,
title: 'EyeTrackVR Docs',
description: 'An awesome docs template built by me',
themeConfig: theme,
})

View File

@ -0,0 +1,12 @@
//https://vitepress.vuejs.org/guide/theme-introduction#customizing-css
import { ThemeSettings } from '../../src/custom/theme'
import '../../src/styles/imports.css'
import DefaultTheme from 'vitepress/theme'
const CustomTheme = {
...DefaultTheme,
...ThemeSettings
}
export default CustomTheme

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 8.5 KiB

View File

@ -0,0 +1,5 @@
const logo = {
src: '/logo.svg',
}
export { logo }

View File

@ -0,0 +1,46 @@
//https://vitepress.vuejs.org/config/theme-configs
//https://vitepress.vuejs.org/guide/theme-nav#navigation-links
//import MyLayout from '../../vue/MyLayout.vue'
import { type ThemeConfig } from "../../static/types/interfaces"
import { logo } from "../logo"
const theme: ThemeConfig = {
logo: logo,
nav: [
{ text: 'Guide', link: '/guide' },
{
text: 'Dropdown Menu',
items: [
{ text: 'Item A', link: '/item-1' },
{ text: 'Item B', link: '/item-2' },
{ text: 'Item C', link: '/item-3' }
]
}
],
sidebar: [
{
text: 'Guide',
items: [
{ text: 'Introduction', link: '/introduction' },
{ text: 'Getting Started', link: '/getting-started' },
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/RedHawk989/EyeTrackVR' },
{ icon: 'discord', link: 'https://discord.gg/kkXYbVykZX' },
// You can also add custom icons by passing SVG as string:
{
icon: {
svg: '<svg role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Dribbble</title><path d="M12...6.38z"/></svg>'
},
link: '...'
}
]
}
const ThemeSettings = {}
export { theme, ThemeConfig, ThemeSettings }

View File

@ -0,0 +1,90 @@
<div align="center">
<div class=".grid-container">
<div class="grid-item">
<a href="https://github.com/RedHawk989/EyeTrackVR/issues">
<img src="https://img.shields.io/github/issues/RedHawk989/EyeTrackVR?style=plastic" />
</a>
</div>
<div class="grid-item">
<a href="https://github.com/RedHawk989/EyeTrackVR/network">
<img src="https://img.shields.io/github/forks/RedHawk989/EyeTrackVR?style=plastic" />
</a>
</div>
</div>
</div>
[![GitHub stars](https://img.shields.io/github/stars/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/stargazers)
[![Build Github Pages Source Code](https://github.com/redhawk989/EyeTrackVR/actions/workflows/build-jekyll.yml/badge.svg?branch=docs)](https://github.com/redhawk989/EyeTrackVR/actions/workflows/build-jekyll.yml)
[![Deploy to Github Pages](https://github.com/redhawk989/EyeTrackVR/actions/workflows/pages/pages-build-deployment/badge.svg?branch=docs)](https://github.com/redhawk989/EyeTrackVR/actions/workflows/pages/pages-build-deployment)
![Website](https://img.shields.io/website?down_color=red&down_message=Git%20Pages%20is%20Down%21&style=plastic&up_color=blue&up_message=Git%20Pages%20is%20Up%21&url=https%3A%2F%2Fredhawk989.github.io%2FEyeTrackVR%2F)
# EyeTrackVR {.text-3xl .font-bold .underline}
<div class="my-8 max-w-xs rounded-lg bg-white px-6 py-8 shadow-xl ring-1 ring-slate-900/5 dark:bg-slate-800">
<div>
<span class="inline-flex items-center justify-center rounded-md bg-indigo-500 p-2 shadow-lg">
<svg xmlns="http://www.w3.org/2000/svg" class="h-6 w-6 text-white" fill="none" viewBox="0 0 24 24" stroke="currentColor" stroke-width="2"><path stroke-linecap="round" stroke-linejoin="round" d="M11 5H6a2 2 0 00-2 2v11a2 2 0 002 2h11a2 2 0 002-2v-5m-1.414-9.414a2 2 0 112.828 2.828L11.828 15H9v-2.828l8.586-8.586z" /></svg>
</span>
</div>
<h3 class="mt-5 text-base font-medium tracking-tight text-slate-900 dark:text-white">Writes Upside-Down</h3>
<p class="mt-2 text-sm text-slate-500 dark:text-slate-400">The Zero Gravity Pen can be used to write in any orientation, including upside-down. It even works in outer space.</p>
</div>
Open source and *affordable* VR eye tracker platform for [VRChat](https://hello.vrchat.com/) via `OSC` and `UDP` protocol.
#### This project is in development and is not fully finished however, it is working for most users
## Hardware
Please check out our [Parts list](https://redhawk989.github.io/EyeTrackVR/parts-list/) and our [full build guide](https://redhawk989.github.io/EyeTrackVR/full-build-guide/) along with our [hardware repo.](https://github.com/RedHawk989/EyeTrackVR-Hardware)
## About IR Emitter Safety
Please *exercise extreme caution* when messing around with IR emitters.
<ins>Once safety testing has been completed links and files will be provided for the emitters</ins>. Please do not try to make, or use any emitters unless you know exactly what you are doing as it could be very harmful to your eyes if not done correctly.
When files and resources are released <ins>**DO NOT BYPASS (OR NOT DO) ANY SAFETY FEATURES PUT IN PLACE**</ins>. This can result in irreversible bodily harm.
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.
##### Make sure you are using **NON-focused** emitters and at around ***5ma total power***
[Effect of infrared radiation on the lens](./docs/Reference_Docs/saftey/effect_of_ir_on_the_lens.pdf)
[Training-library Nir Stds](./docs/Reference_Docs/saftey/training-library_nir_stds_20021011.pdf)
[AN002_Details on photobiological safety of LED light sources](./docs/Reference_Docs/saftey/AN002_Details_on_photobiological_safety_of_LED_light_sources.pdf)
## Firmware
Our firmware called OpenIris is made by `lorow` found [here](https://github.com/lorow/OpenIris).
## Headset support
Please take a look at our list of [3d printable mounts](https://redhawk989.github.io/EyeTrackVR/parts-list/#other-parts) and see if your headset is on the list.
If it is not listed, It is recommended that you try to make a mount, or wait for a skilled community member to create one.
#### Contact
Please join our discord for updates and any questions.
[![Discord](https://discord.com/api/guilds/946212245187199026/widget.png?style=banner3)](https://discord.gg/kkXYbVykZX)
# Licenses
[![GitHub license](https://img.shields.io/github/license/RedHawk989/EyeTrackVR?style=plastic)](https://github.com/RedHawk989/EyeTrackVR/blob/main/LICENSE)
***All software is under the [MIT License](http://opensource.org/licenses/MIT).
All documentation, including the [Wiki](https://github.com/RedHawk989/EyeTrackVR/wiki), is under the Creative Commons CC-BY-SA-4.0 license***.
<!-- <div align="center">
<img src="./docs/assets/images/licenses/licenses.svg" width="300" alt="Open Licenses" />
</div> -->
[Top](#eyetrackvr)

View File

@ -0,0 +1,3 @@
export interface ThemeConfig {
}

View File

@ -0,0 +1,18 @@
/* .vitepress/theme/custom.css */
/** Import all project related CSS files here */
/*! Do not put raw CSS code in this file */
/* Fonts */
@import url('https://fonts.googleapis.com/css2?family=Poppins:wght@200;300;400;500;600;700;800;900&display=swap');
@import url('https://fonts.googleapis.com/css2?family=Lato:wght@300;400;700;900&display=swap');
@import url('https://fonts.googleapis.com/css?family=Ubuntu:500');
/* Custom Imports */
@import 'index.css';
/* TailWindCSS Files */
@tailwind base;
@tailwind components;
@tailwind utilities;

View File

@ -0,0 +1,36 @@
@layer components {
.grid-container {
display: grid;
column-gap: 50px;
row-gap: 50px;
}
}
/* width */
::-webkit-scrollbar {
width: 6px;
}
/* Track */
::-webkit-scrollbar-track {
box-shadow: inset 0 0 5px grey;
margin-top: 0.48rem;
margin-bottom: 0.48rem;
border-radius: 1rem;
}
/* Handle */
::-webkit-scrollbar-thumb {
background: #ae6d6d;
border-radius: 1rem;
}
/* Handle on hover */
::-webkit-scrollbar-thumb:hover {
background: #b24646;
}
:root {
--vp-c-brand: #646cff;
--vp-c-brand-light: #747bff;
}

22
vitepress/package.json Normal file
View File

@ -0,0 +1,22 @@
{
"name": "etvr_docs",
"version": "1.0.0",
"description": "Official Docs for ETVR",
"main": "index.js",
"repository": "https://github.com/RedHawk989/EyeTrackVR",
"author": "DaOfficialWizard",
"license": "MIT",
"private": true,
"scripts": {
"dev": "vitepress dev docs",
"build": "vitepress build docs",
"serve": "vitepress serve docs"
},
"devDependencies": {
"vitepress": "^1.0.0-alpha.35",
"vue": "^3.2.45",
"postcss-flexbugs-fixes": "^5.0.2",
"postcss-preset-env": "^7.7.2",
"tailwindcss": "^3.1.5"
}
}

View File

@ -0,0 +1,7 @@
module.exports = {
darkMode: 'class',
content: [
'./docs/**/*.{html,js,vue,ts,md}',
'./docs/.vitepress/**/*.{html,js,vue,ts,md}',
],
};

1406
vitepress/yarn.lock Normal file

File diff suppressed because it is too large Load Diff