diff --git a/Dockerfile b/Dockerfile index 401b108..9fff995 100755 --- a/Dockerfile +++ b/Dockerfile @@ -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 diff --git a/README.md b/README.md index a0cc527..f9ea208 100755 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@
- +
@@ -10,14 +10,17 @@
ButterflyVu is a documentation template built on the Astro Web Framework.
-## Running +
+ +
+ + + +## Development > `bun` will be used over `npm` in instructions. ### Requirements - Git - - Bun 1 2 - -

1. SudoVanilla recommends using the Bun package manager for Astro projects.

-

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)

+ - 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/ diff --git a/TODO.md b/TODO.md deleted file mode 100755 index cfd2787..0000000 --- a/TODO.md +++ /dev/null @@ -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 \ No newline at end of file diff --git a/astro.config.mjs b/astro.config.mjs index bd0d9e6..a929dc3 100755 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -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' diff --git a/config.json b/config.json index e9d833f..39c6047 100755 --- a/config.json +++ b/config.json @@ -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, diff --git a/package.json b/package.json index 47afa0a..902fc68 100755 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "butterflyvu", "type": "module", - "version": "0.1.9", + "version": "0.2.0", "license": "MIT NON-AI License", "author": { "name": "SudoVanilla" diff --git a/src/components/LinkCard.astro b/src/components/LinkCard.astro new file mode 100644 index 0000000..2ddf48e --- /dev/null +++ b/src/components/LinkCard.astro @@ -0,0 +1,27 @@ +--- +// Properties +const { + Text, + Link, + Direction +} = Astro.props + +// Icons +import { ArrowLeft, ArrowRight } from "@iconoir/vue" +--- + + + + { + ()=> { + if (Direction === "right") { + return

{Text}

+ } else if (Direction === "left") { + return

{Text}

+ } + } + } + + + + diff --git a/src/content/docs/syntax.mdx b/src/content/docs/syntax.mdx index 67c69b9..bc8767e 100755 --- a/src/content/docs/syntax.mdx +++ b/src/content/docs/syntax.mdx @@ -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. \ No newline at end of file +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. + + \ No newline at end of file diff --git a/src/content/home.mdx b/src/content/home.mdx index 3f688d6..013a5fb 100755 --- a/src/content/home.mdx +++ b/src/content/home.mdx @@ -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: "#" diff --git a/src/layouts/Document.astro b/src/layouts/Document.astro index dbc1994..1fc3496 100755 --- a/src/layouts/Document.astro +++ b/src/layouts/Document.astro @@ -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 diff --git a/src/layouts/Splash.astro b/src/layouts/Splash.astro index c9968b0..b72f597 100755 --- a/src/layouts/Splash.astro +++ b/src/layouts/Splash.astro @@ -38,4 +38,14 @@ import "@styles/feelback.css";