Fix issue #79: Implement documentation
All checks were successful
Test / test (push) Successful in 2s

This commit is contained in:
Gitea OpenCode Agent
2026-10-15 19:07:09 +00:00
parent a8a1e0ca41
commit 788f69efd3
27 changed files with 1731 additions and 70 deletions

View File

@@ -0,0 +1,67 @@
<script setup>
import ContentManager from '../managers/ContentManager.vue';
import ToastManager from '../managers/ToastManager.vue';
import WindowManager from '../managers/WindowManager.vue';
import ServiceLinkAuthorize from './ServiceLinkAuthorize.vue';
import { CreateWindow } from '@/services/Windows'
import { GetUser, HasAdmin } from '@/services/User';
import TooltipManager from '../managers/TooltipManager.vue';
import ContextMenuManager from '../managers/ContextMenuManager.vue';
import { useCampaignService } from '@/services/Campaign';
const { RestoreCampaign } = useCampaignService();
// Els serveis (Discord, Foundry, Obsidian) enllacen amb aquesta pantalla única; no són part
// de l'aplicació i no han d'arrencar les finestres normals. La ruta antiga de Discord també
// hi porta, perquè els enllaços que ja corren per Discord no queden morts.
const requestUrl = useRequestURL();
const isServiceLink = computed(() => {
const path = requestUrl.pathname.replace(/\/+$/, '');
return path === '/link/authorize' || path === '/discord/authorize';
});
async function start(){
if(GetUser()){
const restoredCampaign = await RestoreCampaign();
if (!restoredCampaign) {
CreateWindow('main_menu');
}
return;
}
if(await HasAdmin()){
CreateWindow('login');
} else {
CreateWindow('register', {firstTime: true});
}
// DisplayToast('aqua', 'All plugins loaded successfully');
}
onMounted(() => {
if(!isServiceLink.value){
start();
}
})
</script>
<template>
<ServiceLinkAuthorize v-if="isServiceLink"></ServiceLinkAuthorize>
<div v-else class="viewer">
<ToastManager></ToastManager>
<TooltipManager></TooltipManager>
<ContextMenuManager></ContextMenuManager>
<WindowManager></WindowManager>
<ContentManager></ContentManager>
<!-- Managers -->
</div>
</template>
<style scoped>
.viewer {
display: flex;
flex-direction: column;
width: 100%;
height: 100vh;
}
</style>

View File

@@ -0,0 +1,404 @@
<script setup>
import { computed } from 'vue';
import { GetDocsFirstSlug, GetDocsNav, GetDocsPage } from '~/services/Docs';
// La documentació pública, a /docs: el sumari a l'esquerra, la pàgina al centre i els
// apartats d'aquesta pàgina a la dreta. Tot el que hi ha escrit ve dels markdown de
// app/content/docs (mira ~/services/Docs.js), i cada enllaç del sumari és una ruta,
// així que moure-s'hi no recarrega la pàgina.
const route = useRoute();
const slug = computed(() => String(route.params.slug || GetDocsFirstSlug()));
const page = computed(() => GetDocsPage(slug.value));
const nav = GetDocsNav();
useHead({
title: computed(() => `${page.value?.title || 'Documentation'} · Dragonroll`)
});
</script>
<template>
<div class="docs">
<aside class="docs-sidebar">
<NuxtLink class="docs-brand" to="/">
<img src="/img/logo.png" alt="Dragonroll logo" class="docs-logo" draggable="false">
<span>{{ $t('docs.title') }}</span>
</NuxtLink>
<nav class="docs-contents" :aria-label="$t('docs.contents')">
<section v-for="group in nav" :key="group.key" class="docs-group">
<h2 class="docs-group-title">{{ $t(`docs.groups.${group.key}`) }}</h2>
<ul>
<li v-for="entry in group.pages" :key="entry.slug">
<NuxtLink
:to="entry.href"
class="docs-nav-link"
:class="{ active: entry.slug === slug }"
>{{ entry.title }}</NuxtLink>
</li>
</ul>
</section>
</nav>
<NuxtLink class="docs-open" to="/">{{ $t('docs.open-app') }}</NuxtLink>
</aside>
<main class="docs-main">
<template v-if="page">
<article class="docs-article">
<p class="docs-kicker">{{ $t(`docs.groups.${page.group}`) }}</p>
<!-- El contingut és markdown nostre, de app/content/docs -->
<div class="docs-markdown" v-html="page.html"></div>
</article>
<nav class="docs-pager">
<NuxtLink
v-if="page.previous"
:to="page.previous.href"
class="docs-pager-link"
>
<span class="docs-pager-label">{{ $t('docs.previous') }}</span>
<strong>{{ page.previous.title }}</strong>
</NuxtLink>
<NuxtLink
v-if="page.next"
:to="page.next.href"
class="docs-pager-link next"
>
<span class="docs-pager-label">{{ $t('docs.next') }}</span>
<strong>{{ page.next.title }}</strong>
</NuxtLink>
</nav>
</template>
<article v-else class="docs-article">
<h1>{{ $t('docs.title') }}</h1>
<p>{{ $t('docs.not-found', { page: slug }) }}</p>
<p><NuxtLink to="/docs">{{ $t('docs.back-to-docs') }}</NuxtLink></p>
</article>
</main>
<aside
v-if="page && page.headings.length"
class="docs-sections"
:aria-label="$t('docs.on-this-page')"
>
<h2>{{ $t('docs.on-this-page') }}</h2>
<ul>
<li
v-for="heading in page.headings"
:key="heading.slug"
:class="`depth-${heading.depth}`"
>
<a :href="`#${heading.slug}`">{{ heading.text }}</a>
</li>
</ul>
</aside>
</div>
</template>
<style scoped lang="scss">
.docs {
display: flex;
align-items: flex-start;
width: 100%;
min-height: 100vh;
box-sizing: border-box;
background-color: var(--color-background);
color: var(--color-text);
}
.docs-sidebar,
.docs-sections {
position: sticky;
top: 0;
max-height: 100vh;
overflow-y: auto;
box-sizing: border-box;
padding: 18px 14px;
}
.docs-sidebar {
flex: 0 0 268px;
width: 268px;
border-right: 1px solid var(--color-border);
background-color: var(--color-background-light);
display: flex;
flex-direction: column;
gap: 14px;
}
.docs-brand {
display: flex;
align-items: center;
gap: 10px;
font-family: 'MrEavesRemake', serif;
font-size: 1.15rem;
text-decoration: none;
}
.docs-logo {
width: 30px;
height: 30px;
}
.docs-contents {
display: flex;
flex-direction: column;
gap: 16px;
}
.docs-group-title {
margin: 0 0 6px 0;
font-family: 'MrEavesRemake', serif;
font-size: 0.78rem;
font-weight: normal;
letter-spacing: 0.08em;
text-transform: uppercase;
color: var(--color-gray);
}
.docs-contents ul {
margin: 0;
padding: 0;
list-style: none;
display: flex;
flex-direction: column;
gap: 2px;
}
.docs-nav-link {
display: block;
padding: 6px 9px;
border-radius: 6px;
font-size: 0.97rem;
line-height: 1.35;
color: var(--color-text);
text-decoration: none;
}
.docs-nav-link:hover {
background-color: var(--color-hover);
}
.docs-nav-link.active {
background-color: var(--color-background-soft);
color: var(--color-link);
}
.docs-open {
margin-top: auto;
padding: 8px 9px;
border: 1px solid var(--color-border);
border-radius: 6px;
background-color: var(--color-button-background);
font-size: 0.95rem;
text-align: center;
text-decoration: none;
}
.docs-open:hover {
background-color: var(--color-button-hover);
}
.docs-main {
flex: 1;
min-width: 0;
padding: 26px 34px 60px 34px;
box-sizing: border-box;
}
.docs-article {
max-width: 760px;
}
.docs-kicker {
margin: 0 0 4px 0;
font-size: 0.8rem;
letter-spacing: 0.08em;
text-transform: uppercase;
color: var(--color-gray);
}
.docs-pager {
max-width: 760px;
margin-top: 34px;
padding-top: 18px;
border-top: 1px solid var(--color-border);
display: flex;
gap: 14px;
}
.docs-pager-link {
flex: 1 1 0;
min-width: 0;
padding: 10px 12px;
border: 1px solid var(--color-border);
border-radius: 8px;
color: var(--color-text);
text-decoration: none;
}
.docs-pager-link:hover {
background-color: var(--color-hover);
}
.docs-pager-link.next {
text-align: right;
}
.docs-pager-label {
display: block;
font-size: 0.78rem;
letter-spacing: 0.06em;
text-transform: uppercase;
color: var(--color-gray);
}
.docs-sections {
flex: 0 0 220px;
width: 220px;
border-left: 1px solid var(--color-border);
}
.docs-sections h2 {
margin: 0 0 8px 0;
font-family: 'MrEavesRemake', serif;
font-size: 0.78rem;
font-weight: normal;
letter-spacing: 0.08em;
text-transform: uppercase;
color: var(--color-gray);
}
.docs-sections ul {
margin: 0;
padding: 0;
list-style: none;
}
.docs-sections li.depth-3 {
padding-left: 10px;
}
.docs-sections a {
display: block;
padding: 3px 0;
font-size: 0.9rem;
line-height: 1.35;
color: var(--color-gray);
text-decoration: none;
}
.docs-sections a:hover {
color: var(--color-link);
}
/* El markdown renderitzat: tot dins de .docs-markdown, perquè ve de v-html. */
.docs-markdown :deep(h1) {
margin: 0 0 14px 0;
font-family: 'MrEavesRemake', serif;
font-size: 2rem;
font-weight: normal;
line-height: 1.2;
}
.docs-markdown :deep(h2) {
margin: 30px 0 10px 0;
padding-bottom: 4px;
border-bottom: 1px solid var(--color-border);
font-family: 'MrEavesRemake', serif;
font-size: 1.35rem;
font-weight: normal;
scroll-margin-top: 20px;
}
.docs-markdown :deep(h3) {
margin: 22px 0 8px 0;
font-family: 'MrEavesRemake', serif;
font-size: 1.1rem;
font-weight: normal;
scroll-margin-top: 20px;
}
.docs-markdown :deep(p),
.docs-markdown :deep(li) {
line-height: 1.65;
}
.docs-markdown :deep(ul),
.docs-markdown :deep(ol) {
margin: 10px 0;
padding-left: 1.5em;
}
.docs-markdown :deep(a) {
color: var(--color-link);
}
.docs-markdown :deep(code) {
padding: 1px 5px;
border-radius: 4px;
background-color: var(--color-background-light);
font-family: ui-monospace, SFMono-Regular, Menlo, Consolas, monospace;
font-size: 0.9em;
}
.docs-markdown :deep(pre) {
margin: 14px 0;
padding: 12px 14px;
border: 1px solid var(--color-border);
border-radius: 8px;
background-color: var(--color-background-light);
overflow-x: auto;
}
.docs-markdown :deep(pre code) {
padding: 0;
background-color: transparent;
}
.docs-markdown :deep(table) {
margin: 14px 0;
border-collapse: collapse;
width: 100%;
}
.docs-markdown :deep(th),
.docs-markdown :deep(td) {
padding: 7px 10px;
border: 1px solid var(--color-border);
text-align: left;
vertical-align: top;
line-height: 1.5;
}
.docs-markdown :deep(th) {
background-color: var(--color-background-light);
}
@media (max-width: 1200px) {
.docs-sections {
display: none;
}
}
@media (max-width: 900px) {
.docs {
flex-direction: column;
}
.docs-sidebar,
.docs-sections {
position: static;
max-height: none;
width: 100%;
border-left: none;
border-right: none;
}
.docs-main {
padding: 20px 18px 40px 18px;
}
}
</style>