Skip to content

Commit 00829cc

Browse files
committed
feat: creating library page
1 parent 4a8e6c1 commit 00829cc

6 files changed

Lines changed: 70 additions & 9 deletions

File tree

astro.config.mjs

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@
22
import { defineConfig } from "astro/config";
33
import starlight from "@astrojs/starlight";
44
import starlightThemeRapide from "starlight-theme-rapide";
5-
import starlightLinksValidator from 'starlight-links-validator'
5+
import starlightLinksValidator from "starlight-links-validator";
6+
import starlightImageZoom from "starlight-image-zoom";
67

78
// https://astro.build/config
89
export default defineConfig({
910
integrations: [
1011
starlight({
11-
plugins: [starlightThemeRapide(), starlightLinksValidator()],
12+
plugins: [
13+
starlightThemeRapide(),
14+
starlightLinksValidator(),
15+
starlightImageZoom(),
16+
],
1217
title: "Drop OSS",
1318
social: [
1419
{

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"@astrojs/starlight": "^0.37.4",
1414
"astro": "^5.6.1",
1515
"sharp": "^0.34.2",
16+
"starlight-image-zoom": "^0.13.2",
1617
"starlight-links-validator": "^0.19.2",
1718
"starlight-theme-rapide": "^0.5.2"
1819
}

pnpm-lock.yaml

Lines changed: 19 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

src/content/docs/admin/guides/creating-library.md

Lines changed: 0 additions & 5 deletions
This file was deleted.
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Creating a library
3+
---
4+
5+
import { Steps } from "@astrojs/starlight/components";
6+
7+
To import games and start using Drop, you must first create a library to import from.
8+
9+
<Steps>
10+
11+
1. **Decide on a library layout.**
12+
13+
Drop supports different layouts for your files on disk, you can read more about them in the [Library Sources](/reference/library-sources) reference section.
14+
15+
2. **Mount your library in the Docker container.**
16+
17+
For Drop to access your library, you must mount it within the Docker container.
18+
19+
```diff
20+
drop:
21+
image: ghcr.io/drop-oss/drop:latest
22+
...
23+
volumes:
24+
+ - /mnt/media/my-drop-library:/library
25+
```
26+
27+
Where:
28+
- `/mnt/media/my-drop-library` is the path to your library.
29+
- `/library` is a **unique** path inside the container. **Use something else if another volume mounts to `/library`**.
30+
31+
If you followed the [Quickstart](../quickstart.md) guide, you'll have already set up a library at `./library` pointing to `/library` within the container. You may want to instead edit that line in the `volumes` section to point to where your library is located.
32+
33+
3. **Open library source interface in Admin Dashboard.**
34+
35+
Head to your admin dashboard, and click on the "Library" tab. Then, in the top rightmost corner, click on "Sources".
36+
37+
4. **Create your library source.**
38+
39+
Use the "Create" button in the top right to create your library source. Use the **path from inside the container** when providing the path for the library, like `/library` from Step 2.
40+
41+
</Steps>

src/content/docs/reference/library-sources.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ So your game has gotten an update and you've got new files. All you need to do i
5050

5151
If you have files that you're supposed to **paste over the previous version**, Drop supports that! Read [Update mode](./update-mode.mdx) to find out more.
5252

53-
# Flat-style or 'compat'
53+
# Compatibility (flat-style)
5454

55-
This is a more commonly used layout for game libraries, but doesn't support all of Drop's features. It's useful when you want to migrate to Drop from another application or having an existing library. **We recommend [Drop-style](#drop-style) libraries if you're starting from scratch**.
55+
This is a more commonly used layout for game libraries, but doesn't support all of Drop's features. It's useful when you want to migrate to Drop from another application or have an existing library. **We recommend [Drop-style](#drop-style) libraries if you're starting from scratch**.
5656

5757
## Structuring your library
5858

0 commit comments

Comments
 (0)