Compare commits

...

4 commits

Author SHA1 Message Date
Korbs
3d21ef0df2 update 2024-11-12 19:17:58 -05:00
Korbs
aca0aea1a8 Setup Compose 2024-11-12 19:17:54 -05:00
Korbs
786263ff9c Create configuration 2024-11-12 19:17:44 -05:00
Korbs
f454944e43 Move all documentation to /docs/ directory 2024-11-12 19:17:37 -05:00
10 changed files with 86 additions and 2 deletions

1
.gitignore vendored Normal file
View file

@ -0,0 +1 @@
dists

61
config.json Normal file
View file

@ -0,0 +1,61 @@
{
"SiteSettings": {
"OrgName": "SudoVanilla",
"SiteName": "MinPluto",
"SiteProtocol": "https",
"SiteDomain": "minpluto.docs.sudovanilla.org",
"SiteBase": "",
"MetaColor": "",
"WhiteLabel": "true",
"FooterVersion": "true"
},
"HeaderItems": [
{
"text": "Documentation",
"link": "/introduction/"
},
{
"text": "Source Code",
"link": "https://ark.sudovanilla.org/MinPluto/MinPluto/"
}
],
"SidebarItems": [
{
"heading": "Introduction"
},
{
"text": "Introduction",
"link": "/introduction/"
},
{
"text": "FAQ",
"link": "/faq/"
},
{
"text": "Compatibility",
"link": "/compatibility/"
},
{
"text": "Support",
"link": "/support/"
},
{
"heading": "Setup"
},
{
"text": "Requirements",
"link": "/requirements/"
},
{
"text": "Self-Hosting",
"link": "/self-hosting/"
},
{
"heading": "References"
},
{
"text": "API",
"link": "/api/"
}
]
}

16
docker-compose.yml Normal file
View file

@ -0,0 +1,16 @@
services:
butterflyvu:
image: ark.sudovanilla.org/korbs/butterlyvu:amd64
volumes:
- ./config.json:/app/config.json
- ./docs/:/app/src/content/docs/
- ./dists/:/app/dist/
nginx:
image: nginx:latest
restart: unless-stopped
network_mode: bridge
ports:
- 4242:80
volumes:
- ./dists/:/usr/share/nginx/html/

View file

@ -2,6 +2,10 @@
Title: API Title: API
Type: Document Type: Document
--- ---
---
import { Prism } from '@astrojs/prism';
## Generic ## Generic
**Language** **Language**
@ -30,7 +34,8 @@ Enable or disable the Milieu mode.
When a user registered an account, it is processed with the following data: When a user registered an account, it is processed with the following data:
```JSON <Prism lang="json" code={
`
{ {
"name": "PROVIDED_NAME", "name": "PROVIDED_NAME",
"ui_theme": "Default", "ui_theme": "Default",
@ -44,7 +49,8 @@ When a user registered an account, it is processed with the following data:
"image_proxy": "https://ipx.sudovanilla.org", "image_proxy": "https://ipx.sudovanilla.org",
"player_type": "Zorn" "player_type": "Zorn"
} }
``` `
} />
The end-user is then redirected to `/?=welcome` with an onboarding screen(Planned, this actually does nothing for now). The end-user is then redirected to `/?=welcome` with an onboarding screen(Planned, this actually does nothing for now).

View file