✨ Added docs written in Markdown
This commit is contained in:
@@ -0,0 +1,20 @@
|
||||
<!--
|
||||
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
- file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
-->
|
||||
<script lang="ts">
|
||||
import { onMount } from 'svelte';
|
||||
import '$lib/hljs.css';
|
||||
|
||||
onMount(async () => {
|
||||
const { default: hljs } = await import('highlight.js/lib/common');
|
||||
hljs.highlightAll();
|
||||
});
|
||||
</script>
|
||||
|
||||
<article
|
||||
class="prose prose-sm sm:prose lg:prose-lg xl:prose-xl mx-auto mt-10 prose-slate px-4 dark:prose-invert"
|
||||
>
|
||||
<slot />
|
||||
</article>
|
||||
@@ -0,0 +1,5 @@
|
||||
# Features
|
||||
|
||||
|
||||
- [Custom-Field](/docs/features/custom-field)
|
||||
- [Remote-Control](/docs/features/remote-control)
|
||||
@@ -0,0 +1,24 @@
|
||||
<!--
|
||||
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
- file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
-->
|
||||
|
||||
# Custom Field
|
||||
|
||||
## What is the Custom-Field?
|
||||
|
||||
The Custom-Field is an input-field which can be enabled in the start-quiz modal. The custom-field has to be named, and
|
||||
then it will be displayed if a player wants to join.
|
||||
|
||||
## Use Case
|
||||
|
||||
Imagine you're a teacher, and you want to know the real names of your students, but you don't want everyone to see
|
||||
who is behind which username. That's where the custom-field comes into play. Players can enter their username and their
|
||||
real name and only the admin (you) can see which username belongs to which real name and which real names exist. The
|
||||
data can be obtained by downloading the quiz-results at the end. In the spreadsheet, you can then see all the data.
|
||||
|
||||
## Notes
|
||||
|
||||
- There is no validation at all. Users can also leave it empty, enter numbers and more.
|
||||
- The value gets saved for future use, so make sure to clear it before starting a new quiz.
|
||||
@@ -0,0 +1,15 @@
|
||||
<!--
|
||||
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
- file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
-->
|
||||
|
||||
# Remote Control
|
||||
|
||||
Control the admin-screen from a different device!
|
||||
|
||||
## Use Case
|
||||
|
||||
Imagine mirroring the admin-screen to a projector and you want to show the quiz full-screen without the disruption of
|
||||
buttons, etc. That's where this feature comes in handy, since you can control the quiz from another device, e.g. your
|
||||
phone.
|
||||
@@ -1,3 +1,9 @@
|
||||
<!--
|
||||
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
- file, You can obtain one at https://mozilla.org/MPL/2.0/.
|
||||
-->
|
||||
|
||||
<!--
|
||||
- This Source Code Form is subject to the terms of the Mozilla Public
|
||||
- License, v. 2.0. If a copy of the MPL was not distributed with this
|
||||
@@ -28,5 +34,8 @@
|
||||
<li>
|
||||
<a href="/docs/develop">Development-Setup</a>
|
||||
</li>
|
||||
<li>
|
||||
<a href="/docs/features">Features</a>
|
||||
</li>
|
||||
</ul>
|
||||
</article>
|
||||
|
||||
Reference in New Issue
Block a user