EyeTrackVR-Docs/assets/development_docs_dev_docs.md.6a5db7eb.js
RedHawk989 5ca7660ff7 docs: Merge pull request #21 from lorow/main
Fix upload and download actions deprecation, updated to v4
2024-10-01 18:27:11 +00:00

2 lines
5.0 KiB
JavaScript
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

import{_ as a,o as t,c as s,O as r}from"./chunks/framework.79850ceb.js";const u=JSON.parse('{"title":"Development Documentation for the EyeTrackVR Docs Site","description":"","frontmatter":{},"headers":[],"relativePath":"development/docs/dev_docs.md","filePath":"development/docs/dev_docs.md","lastUpdated":1689147044000}'),n={name:"development/docs/dev_docs.md"};function o(l,e,i,c,p,d){return t(),s("div",null,e[0]||(e[0]=[r('<h1 id="development-documentation-for-the-eyetrackvr-docs-site" tabindex="-1">Development Documentation for the EyeTrackVR Docs Site <a class="header-anchor" href="#development-documentation-for-the-eyetrackvr-docs-site" aria-label="Permalink to &quot;Development Documentation for the EyeTrackVR Docs Site&quot;"></a></h1><p>This is the documentation for the EyeTrackVR Docs site. It is built using <a href="https://vitepress.vuejs.org/" target="_blank" rel="noreferrer">VitePress</a>.</p><h2 id="getting-started" tabindex="-1">Getting Started <a class="header-anchor" href="#getting-started" aria-label="Permalink to &quot;Getting Started&quot;"></a></h2><h3 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to &quot;Prerequisites&quot;"></a></h3><ul><li><a href="https://nodejs.org/en/" target="_blank" rel="noreferrer">Node.js</a> (v14.15.4 or higher)</li><li><a href="https://yarnpkg.com/" target="_blank" rel="noreferrer">Yarn</a> (v1.22.10 or higher)</li><li><a href="https://git-scm.com/" target="_blank" rel="noreferrer">Git</a> (v2.30.1 or higher)</li><li><a href="https://code.visualstudio.com/" target="_blank" rel="noreferrer">VSCode</a> (v1.56.2 or higher)</li></ul><h3 id="installation" tabindex="-1">Installation <a class="header-anchor" href="#installation" aria-label="Permalink to &quot;Installation&quot;"></a></h3><ol><li><p>Clone the repo</p><div class="language-sh line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">git</span><span style="color:#BABED8;"> </span><span style="color:#C3E88D;">clone</span><span style="color:#BABED8;"> </span><span style="color:#C3E88D;">https://github.com/EyeTrackVR/EyeTrackVR-Docs.git</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div></li><li><p>Navigate to the <code>vitepress</code> folder</p><div class="language-sh line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#82AAFF;">cd</span><span style="color:#BABED8;"> </span><span style="color:#C3E88D;">vitepress</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div></li><li><p>Install Yarn packages</p><div class="language-sh line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#BABED8;"> </span><span style="color:#FFCB6B;">yarn</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div></li><li><p>Start the dev server</p><div class="language-sh line-numbers-mode"><button title="Copy Code" class="copy"></button><span class="lang">sh</span><pre class="shiki material-theme-palenight"><code><span class="line"><span style="color:#FFCB6B;">yarn</span><span style="color:#BABED8;"> </span><span style="color:#C3E88D;">dev</span></span></code></pre><div class="line-numbers-wrapper" aria-hidden="true"><span class="line-number">1</span><br></div></div></li><li><p>Open the site in your browser</p></li></ol><h2 id="contributing" tabindex="-1">Contributing <a class="header-anchor" href="#contributing" aria-label="Permalink to &quot;Contributing&quot;"></a></h2><h3 id="project-structure" tabindex="-1">Project Structure <a class="header-anchor" href="#project-structure" aria-label="Permalink to &quot;Project Structure&quot;"></a></h3><ol><li>Familiarize yourself with the <a href="https://vitepress.vuejs.org/" target="_blank" rel="noreferrer">VitePress documentation</a>.</li><li>Then, move on to our project specific documentation below.</li></ol><h4 id="standards" tabindex="-1">Standards <a class="header-anchor" href="#standards" aria-label="Permalink to &quot;Standards&quot;"></a></h4><ul><li>All documentation should be written in Markdown or Vue components.</li><li>All file names are snake case <em>and</em> lowercase letters.</li><li>Do not make naming changes to the <code>vitepress</code> folder.</li><li>Do not make major changes to the <code>vitepress</code> folder structure without proir consultation of team members.</li><li>For Vue componentes, follow the <a href="https://vuejs.org/guide/introduction.html" target="_blank" rel="noreferrer">Vue3 docs</a>.</li></ul>',12)]))}const m=a(n,[["render",o]]);export{u as __pageData,m as default};