updated
This commit is contained in:
parent
7b3b7b386a
commit
6088a97c74
12 changed files with 90 additions and 60 deletions
|
@ -8,7 +8,7 @@ LABEL org.opencontainers.image.description="Documentations built on Astro"
|
|||
LABEL org.opencontainers.image.licenses="MIT NON-AI License"
|
||||
LABEL org.opencontainers.image.url="https://butterflyvu.docs.sudovanilla.org/"
|
||||
LABEL org.opencontainers.image.source="https://ark.sudovanilla.org/Korbs/ButterflyVu/"
|
||||
LABEL org.opencontainers.image.version="0.1.9"
|
||||
LABEL org.opencontainers.image.version="0.1.91"
|
||||
|
||||
# Copy Files
|
||||
WORKDIR /app
|
||||
|
|
23
README.md
23
README.md
|
@ -1,6 +1,6 @@
|
|||
<div align="center">
|
||||
|
||||
<img width="128px" src="https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"/>
|
||||
<img width="96px" src="https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"/>
|
||||
|
||||
</div>
|
||||
|
||||
|
@ -10,14 +10,17 @@
|
|||
|
||||
<center>ButterflyVu is a documentation template built on the Astro Web Framework.</center>
|
||||
|
||||
## Running
|
||||
<br/>
|
||||
|
||||
<center><a href="https://nogithub.codeberg.page"><img width="150" src="https://md.sudovanilla.org/images/badges/nogithub/compact.png"/></a></center>
|
||||
|
||||
|
||||
|
||||
## Development
|
||||
> `bun` will be used over `npm` in instructions.
|
||||
### Requirements
|
||||
- Git
|
||||
- Bun <span style="font-size: 8px; opacity: 0.5">1</span> <span style="font-size: 8px; opacity: 0.5">2</span>
|
||||
|
||||
<p style="font-size: 10px; opacity: 0.5">1. SudoVanilla recommends using the Bun package manager for Astro projects.</p>
|
||||
<p style="font-size: 10px; opacity: 0.5">2. If you plan to use Bun, NodeJS is not required to be installed, which is why it's not listed as a requirement. If you use i18n in Astro, then NodeJS will be required. (Tested)</p>
|
||||
- Bun
|
||||
|
||||
### Clone Repository
|
||||
Start by cloning the repository to somewhere on your device using the `git` command:
|
||||
|
@ -46,9 +49,9 @@ If the website is not running and an error appears, troubleshoot the problem by
|
|||
### Requirements
|
||||
It is expected for the server admin to use the Docker method, as it is recommended, so please install the Docker Engine.
|
||||
|
||||
- [Install Docker Engine for Windows]() (WSL Method)
|
||||
- [Install Docker Engine for macOS]() (Homebrew Method)
|
||||
- [Install Docker Engine for Linux]()
|
||||
- [Linux](https://docs.docker.com/engine/install/#supported-platforms)
|
||||
- [macOS](https://richstone.io/best-way-to-install-docker-on-a-mac/) ([Homebrew](https://brew.sh/), without Docker Desktop)
|
||||
- [Windows](https://dev.to/felipecrs/simply-run-docker-on-wsl2-3o8) ([WSL2](https://learn.microsoft.com/en-us/windows/wsl/install), without Docker Desktop)
|
||||
|
||||
SudoVanilla does NOT recommend using the Docker Desktop application, as it is proprietary software.
|
||||
|
||||
|
@ -58,7 +61,7 @@ A Docker Compose file is provided that can be used without needing to clone the
|
|||
```
|
||||
services:
|
||||
butterflyvu:
|
||||
image: ark.sudovanilla.org/korbs/butterlyvu:amd64
|
||||
image: oci.registry.sudovanilla.org/butterflyvu:latest
|
||||
volumes:
|
||||
- ./config.json:/app/config.json
|
||||
- ./docs/:/app/src/content/docs/
|
||||
|
|
42
TODO.md
42
TODO.md
|
@ -1,42 +0,0 @@
|
|||
- [ ] Build Components:
|
||||
- [x] Asides
|
||||
- [x] Badges
|
||||
- [ ] Buttons
|
||||
- [ ] Cards
|
||||
- [ ] Carousel
|
||||
- [x] Code
|
||||
- [ ] Dialog
|
||||
- [ ] File Tree*
|
||||
- [ ] Gallery
|
||||
- [x] Image
|
||||
- [ ] Image Comparer
|
||||
- [ ] Link Cards
|
||||
- [ ] Menu
|
||||
- [x] Search
|
||||
- [ ] Steps
|
||||
- [ ] Tabs
|
||||
- [ ] Sidebar
|
||||
- [x] Make configurable
|
||||
- [ ] Multi
|
||||
- [x] Closable
|
||||
- [x] Mobile friendly
|
||||
- [x] Optimizations
|
||||
- [x] Mobile Friendly
|
||||
- [x] Error Handling
|
||||
- [x] Custom Error Pages
|
||||
- [x] Add Integrations:
|
||||
- [x] Analytics and Event Tracking for:
|
||||
- [x] Umami
|
||||
- [x] Feedback:
|
||||
- [x] Feelback
|
||||
- [x] [Zorn](https://zorn.docs.sudovanilla.org) Support
|
||||
- [ ] Provide Docker Image for AMD64 and ARM64
|
||||
- [x] AMD64
|
||||
- [ ] ARM64
|
||||
- [x] Docker, test with:
|
||||
- [o] ~~Docker Desktop~~ (Discouraged)
|
||||
- [x] Docker Engine
|
||||
- [x] Dockge
|
||||
- [x] Dokemon
|
||||
|
||||
> * Subject to change
|
|
@ -2,7 +2,7 @@ import { defineConfig } from 'astro/config'
|
|||
import vue from "@astrojs/vue"
|
||||
|
||||
// Settings
|
||||
import { SiteSettings, Ghost } from './config.json'
|
||||
import { SiteSettings } from './config.json'
|
||||
|
||||
// Integrations
|
||||
import mdx from '@astrojs/mdx'
|
||||
|
|
|
@ -11,8 +11,8 @@
|
|||
},
|
||||
"Ghost": {
|
||||
"Enabled": true,
|
||||
"Instance": "https://minpluto.ghost.sudovanilla.org",
|
||||
"Key": "22f4a31cd6f8cc0b2a2718a0cd"
|
||||
"Instance": "https://blog.ghost.sudovanilla.org",
|
||||
"Key": "bef2ed15d9e38f7703be9412b3"
|
||||
},
|
||||
"FeelbackConfig": {
|
||||
"Enabled": false,
|
||||
|
|
|
@ -1,7 +1,7 @@
|
|||
{
|
||||
"name": "butterflyvu",
|
||||
"type": "module",
|
||||
"version": "0.1.9",
|
||||
"version": "0.2.0",
|
||||
"license": "MIT NON-AI License",
|
||||
"author": {
|
||||
"name": "SudoVanilla"
|
||||
|
|
27
src/components/LinkCard.astro
Normal file
27
src/components/LinkCard.astro
Normal file
|
@ -0,0 +1,27 @@
|
|||
---
|
||||
// Properties
|
||||
const {
|
||||
Text,
|
||||
Link,
|
||||
Direction
|
||||
} = Astro.props
|
||||
|
||||
// Icons
|
||||
import { ArrowLeft, ArrowRight } from "@iconoir/vue"
|
||||
---
|
||||
|
||||
<a href={Link} style={'float: ' + Direction} class="link-card">
|
||||
|
||||
{
|
||||
()=> {
|
||||
if (Direction === "right") {
|
||||
return <p>{Text}</p> <ArrowRight/>
|
||||
} else if (Direction === "left") {
|
||||
return <ArrowLeft/> <p>{Text}</p>
|
||||
}
|
||||
}
|
||||
}
|
||||
</a>
|
||||
|
||||
|
||||
|
|
@ -1,8 +1,10 @@
|
|||
---
|
||||
Type: Document
|
||||
Title: Welcome
|
||||
Title: Syntax
|
||||
---
|
||||
|
||||
import LinkCard from '@components/LinkCard.astro'
|
||||
|
||||
Documentation template for the Astro Web Framework.
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Nulla facilisi morbi tempus iaculis urna id volutpat. Diam phasellus vestibulum lorem sed risus ultricies tristique nulla. A cras semper auctor neque vitae tempus quam. Tempus quam pellentesque nec nam aliquam. Lorem ipsum dolor sit amet consectetur adipiscing elit ut aliquam. Sed adipiscing diam donec adipiscing tristique risus nec feugiat in. Quis commodo odio aenean sed adipiscing diam. Pharetra et ultrices neque ornare aenean euismod elementum. Egestas fringilla phasellus faucibus scelerisque eleifend donec. Dolor sit amet consectetur adipiscing elit duis tristique sollicitudin nibh.
|
||||
|
@ -113,4 +115,10 @@ Copied from https://ark.sudovanilla.org/Korbs/docker-build-automation.
|
|||
|
||||
Pharetra magna ac placerat vestibulum lectus mauris. Enim lobortis scelerisque fermentum dui. Enim facilisis gravida neque convallis. Mattis rhoncus urna neque viverra justo nec ultrices dui sapien. Sit amet justo donec enim diam vulputate ut pharetra sit. Fusce ut placerat orci nulla pellentesque dignissim. Lectus vestibulum mattis ullamcorper velit. Pellentesque elit eget gravida cum sociis natoque penatibus. Aliquam eleifend mi in nulla posuere sollicitudin aliquam. Interdum varius sit amet mattis vulputate. Egestas integer eget aliquet nibh.
|
||||
|
||||
A lacus vestibulum sed arcu non odio euismod lacinia at. Mauris augue neque gravida in. Nulla facilisi etiam dignissim diam quis enim lobortis scelerisque fermentum. Pharetra massa massa ultricies mi quis hendrerit. Habitant morbi tristique senectus et netus et malesuada fames ac. Placerat vestibulum lectus mauris ultrices. Ullamcorper eget nulla facilisi etiam dignissim diam quis enim. Volutpat lacus laoreet non curabitur gravida arcu ac. Nibh venenatis cras sed felis eget velit aliquet sagittis. Dui faucibus in ornare quam viverra orci sagittis. Lacus vestibulum sed arcu non odio euismod lacinia at quis. Sit amet venenatis urna cursus eget nunc. Ut venenatis tellus in metus vulputate.
|
||||
A lacus vestibulum sed arcu non odio euismod lacinia at. Mauris augue neque gravida in. Nulla facilisi etiam dignissim diam quis enim lobortis scelerisque fermentum. Pharetra massa massa ultricies mi quis hendrerit. Habitant morbi tristique senectus et netus et malesuada fames ac. Placerat vestibulum lectus mauris ultrices. Ullamcorper eget nulla facilisi etiam dignissim diam quis enim. Volutpat lacus laoreet non curabitur gravida arcu ac. Nibh venenatis cras sed felis eget velit aliquet sagittis. Dui faucibus in ornare quam viverra orci sagittis. Lacus vestibulum sed arcu non odio euismod lacinia at quis. Sit amet venenatis urna cursus eget nunc. Ut venenatis tellus in metus vulputate.
|
||||
|
||||
<LinkCard
|
||||
Text="Components"
|
||||
Link="/components"
|
||||
Direction="right"
|
||||
/>
|
|
@ -2,6 +2,7 @@
|
|||
layout: "@layouts/Splash.astro"
|
||||
Title: "Welcome to ButterflyVu"
|
||||
Banner: "https://md.sudovanilla.org/images/logos/butterflyvu/ButterflyVu%20-%20Original.svg"
|
||||
BannerType: "Logo"
|
||||
PrimaryText: "Primary"
|
||||
SecondaryText: "Secondary"
|
||||
PrimaryLink: "#"
|
||||
|
|
|
@ -11,6 +11,7 @@ import Header from '@components/global/Header.astro'
|
|||
import Footer from '@components/global/Footer.astro'
|
||||
import Sidebar from '@components/Sidebar.astro'
|
||||
import FeelbackYesNo from "astro-feelback/components/FeelbackYesNo.astro"
|
||||
import LinkCard from '@components/LinkCard.astro'
|
||||
import {Zorn} from "@minpluto/zorn"
|
||||
|
||||
// Styles
|
||||
|
|
|
@ -38,4 +38,14 @@ import "@styles/feelback.css";
|
|||
</div>
|
||||
<Footer/>
|
||||
</div>
|
||||
</html>
|
||||
</html>
|
||||
|
||||
{
|
||||
()=> {
|
||||
if (frontmatter.BannerType === "Logo") {
|
||||
null
|
||||
} else if (frontmatter.BannerType === "Image") {
|
||||
return <style>.splash-content img {height: 430px; width: 100%;}</style>
|
||||
}
|
||||
}
|
||||
}
|
|
@ -386,6 +386,28 @@ header {
|
|||
}
|
||||
}
|
||||
|
||||
.link-card {
|
||||
border: 2px #575757 solid;
|
||||
display: flex;
|
||||
align-items: center;
|
||||
gap: 12px;
|
||||
border-radius: 6px;
|
||||
padding: 12px 24px;
|
||||
font-size: 14px;
|
||||
width: max-content;
|
||||
text-decoration: none;
|
||||
color: #9d9d9d;
|
||||
&:hover {
|
||||
filter: brightness(1.2)
|
||||
}
|
||||
p {
|
||||
margin: 0px;
|
||||
}
|
||||
svg {
|
||||
width: 16px;
|
||||
}
|
||||
}
|
||||
|
||||
.footer {
|
||||
position: absolute;
|
||||
padding-bottom: 24px;
|
||||
|
|
Loading…
Add table
Reference in a new issue