Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

Commit

Permalink
📝 Add an author to the documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Dlurak committed Nov 10, 2023
1 parent 6237377 commit 177b697
Show file tree
Hide file tree
Showing 5 changed files with 45 additions and 1 deletion.
30 changes: 29 additions & 1 deletion src/routes/documentation/+layout.svelte
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
<script lang="ts">
import { page } from '$app/stores';
import I18n from '$lib/I18n.svelte';
import QuickActionButton from '$lib/QuickActionButton.svelte';
import Toc from '$lib/documentation/TOC.svelte';
Expand All @@ -14,6 +15,22 @@
const directoryTree = mergeObjects(directoryPaths);
let collapsed = false;
let currentPath = $page.route.id?.split('/').slice(2);
const genImportPath = () => `./${currentPath?.join('/')}/+page.md`;
let data = import(
/* @vite-ignore */
genImportPath()
).then((d) => d.metadata);
page.subscribe(() => {
currentPath = $page.route.id?.split('/').slice(2);
data = import(
/* @vite-ignore */
genImportPath()
).then((d) => d.metadata);
});
</script>

<svelte:window
Expand Down Expand Up @@ -49,6 +66,17 @@
</aside>

<div>
<slot />
<div class="pb-6">
<slot />
</div>

<div class="text-xs">
{#await data then d}
{#if d.author}
<i class="bx bx-user" />
{d.author}
{/if}
{/await}
</div>
</div>
</div>
4 changes: 4 additions & 0 deletions src/routes/documentation/+page.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
author: Dlurak
---

## Documentation

This is the start of the documentation for Dlool. It is a work in progress. Help via [GitHub](https://github.com/Dlurak/dloolFrontend) is welcome.
Expand Down
4 changes: 4 additions & 0 deletions src/routes/documentation/api/+page.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
author: Dlurak
---

## API

Dlool has a REST API. It is completely open and can be used by anyone. The API is documented using [ApiDoc](https://apidocjs.com/). You can find the documentation [here](https://dlurak.github.io/dloolBackend/). I plan to migrate the documentation to this site in the future.
Expand Down
4 changes: 4 additions & 0 deletions src/routes/documentation/getting-started/+page.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
author: Dlurak
---

## Getting Started

To get started with Dlool, we recommend you read the [What is Dlool?](/documentation/getting-started/what-is-dlool) page. It will give you a quick overview of what Dlool is and what it can do for you.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
---
author: Dlurak
---

## What is Dlool?

Dlool is a web application to manage your entire school life. It is meant as an easy to use tool for students. While it can be used by teachers and parents, it meant to be used by students. Dlool is highly optimized for exactly that use case.
Expand Down

0 comments on commit 177b697

Please sign in to comment.