Skip to content

Commit

Permalink
Improvements (#3)
Browse files Browse the repository at this point in the history 
* Start making website improvements

* Fix site build

* Fix site formatting

* Change the path to bot files

* Fix nav bar

* Update LilyBot docs

* Update LilyBot docs

* Revert "Update LilyBot docs"

This reverts commit e9a558d.

* Update LilyBot docs

* Update LilyBot docs

* Update about page

* Update LilyBot docs

* Use correct size and src for webmanifest

* Clean up config.ts and remove un-needed plugin stuff

* Work on fixing the eyeball crime

* Add allium to improvements

* Update colours a little bit and re-arrange code

* Switch back to pnpm again

* Update styling and colours

* Remove contributors listing and update text colours

* Fix container colours

* Fix container colours

* Update LilyBot docs

* Update LilyBot docs

* Update Vuepress

* Add description and meta tags, add more info to the about Lily page

* Update contributing guidelines

* Update vue and vuepress

* Revert "Update vue and vuepress"

This reverts commit 1fac196.

* Make updates to site

* Update LilyBot docs

* Do some websiting!

* Make contributing guidelines refer to this repo as the website not LilyBot

I didn't copy and paste it back in the day shush

* Re-fill the navbar with the stuff

* Waa waa formatting

* Update website and tempest description

* Add missing dependency

* Change pnpm-lock.yaml to hopefully actually build

* Maybe?

* Update vuepress, apply hopes and prayers

* Build on github before beaming to cloudflare?

---------

Co-authored-by: = <=>
  • Loading branch information
@NoComment1105
NoComment1105 authored Oct 31, 2024
1 parent ef89035 commit a77f0e2
Show file tree
Hide file tree
Showing 21 changed files with 4,127 additions and 7,042 deletions.
4 changes: 4 additions & 0 deletions .editorconfig
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ insert_final_newline = true
indent_size = 4
indent_style = tab

[*.ts]
indent_size = 4
indent_style = tab

[*.scss]
indent_size = 4
indent_style = tab
Expand Down
65 changes: 65 additions & 0 deletions .github/workflows/main.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
name: Deploy

on:
workflow_dispatch:

push:
branches:
- main

jobs:
deploy-preview:
environment: Site
runs-on: ubuntu-latest

permissions:
contents: read
deployments: write

name: Deploy Prod

steps:
- uses: actions/checkout@v3

with:
fetch-depth: 0

- name: Install node
uses: actions/setup-node@v4
with:
node-version: 20

- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 8

- name: Get pnpm store directory
id: pnpm-cache

run: |
echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
- name: Setup pnpm cache
uses: actions/cache@v3

with:
path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
key: "${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yml') }}"

restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Build site
run: pnpm install && pnpm run docs:build

- name: Deploy to Cloudflare Pages
uses: AdrianGonz97/refined-cf-pages-action@v1

with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
githubToken: ${{ secrets.GITHUB_TOKEN }}
projectName: website
directory: docs/.vuepress/dist
deploymentName: Site
78 changes: 78 additions & 0 deletions .github/workflows/pr.yml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
name: Preview

on:
pull_request_target:

concurrency:
group: "${{ github.workflow }}-${{ github.event.number || github.sha }}"
cancel-in-progress: true

jobs:
deploy-preview:
environment: Preview
runs-on: ubuntu-latest

permissions:
contents: read
pull-requests: write
deployments: write

name: Deploy Preview

steps:
- uses: actions/checkout@v3

with:
fetch-depth: 0
ref: ${{ github.event.pull_request.head.ref }}
repository: ${{ github.event.pull_request.head.repo.full_name }}

- name: Install node
uses: actions/setup-node@v4
with:
node-version: "20"

- name: Install pnpm
uses: pnpm/action-setup@v4
with:
version: 8

- name: Get pnpm store directory
id: pnpm-cache

run: |
echo "pnpm_cache_dir=$(pnpm store path)" >> $GITHUB_OUTPUT
- name: Setup pnpm cache
uses: actions/cache@v3

with:
path: ${{ steps.pnpm-cache.outputs.pnpm_cache_dir }}
key: "${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}"

restore-keys: |
${{ runner.os }}-pnpm-store-
- name: Build site
run: pnpm install && pnpm run build

- name: Deploy to Cloudflare Pages
id: deploy
uses: AdrianGonz97/refined-cf-pages-action@v1

with:
apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
accountId: ${{ secrets.CLOUDFLARE_ACCOUNT_ID }}
githubToken: ${{ secrets.GITHUB_TOKEN }}
projectName: kordex-site-preview
directory: build
deploymentName: Preview

- name: Update PR Comment
uses: thollander/actions-comment-pull-request@v2

with:
comment_tag: "preview-deployment"

message: |
✨ The preview for your Pull Request has been built, and may be found here: [${{steps.deploy.outputs.url}}](${{steps.deploy.outputs.url}})
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ When opening issues, please make sure that you include as much information as ap

## Pull Requests

We love to see when people contribute to the project! Our [Issues Page](https://github.com/IrisShaders/LilyBot/issues)
We love to see people contribute to the project! Our [Issues Page](https://github.com/HyacinthBots/website/issues)
often has a list of features that need to be implemented. However, you'll need to read the following guidelines:

### Contributor License Agreement (CLA)
Expand All @@ -30,16 +30,16 @@ and ask any questions that you may have.
## Pull Request Policy

This PR policy has been adapted from the
[Quilt Mappings](https://github.com/QuiltMC/quilt-mappings/blob/22w14a/CONTRIBUTING.md#guide-pull-requests) PR policy
[Quilt Mappings](https://github.com/QuiltMC/quilt-mappings/blob/HEAD/CONTRIBUTING.md#guide-pull-requests) PR policy

1. ### Look at the code style
Before you begin work on adding code to LilyBot, please spend some time looking through the rest of the code in
Before you begin work on adding code to the website, please spend some time looking through the rest of the code in
LilyBot, and ensure in your Pull Request you follow the style as closely as you can.

If you have any questions, do not hesitate to ask in [our Discord](https://discord.gg/hy2329fcTZ).

2. ### Open your PR and wait for reviews
Once you have forked LilyBot and opened a pull request, you will need to wait for reviews from other people. When you
Once you have forked the website and opened a pull request, you will need to wait for reviews from other people. When you
get reviews, try to thoughtfully address any concerns other people have. If you get confused, be sure to ask
questions!

Expand Down
180 changes: 84 additions & 96 deletions docs/.vuepress/config.ts
View file
Original file line number Diff line number Diff line change
@@ -1,105 +1,93 @@
import {defineUserConfig} from "@vuepress/cli";
import {defaultTheme} from "vuepress";
import {backToTopPlugin} from "@vuepress/plugin-back-to-top";
// noinspection JSUnusedGlobalSymbols

import {viteBundler} from '@vuepress/bundler-vite'
import {defaultTheme} from "@vuepress/theme-default";
import {defineUserConfig} from "vuepress"


export default defineUserConfig({
base: '/',
lang: 'en-US',
title: 'HyacinthBots',
description: 'Discord bots, open source, free, forever.',
base: '/',
lang: 'en-US',
title: 'HyacinthBots',
description: 'Discord bots, open source, free, forever.',
bundler: viteBundler(),

theme: defaultTheme({
logo: 'https://raw.githubusercontent.com/HyacinthBots/art/main/branding/icons/Hyacinth%20transparent%20icon.png',
toggleColorMode: 'Toggle color mode',
toggleSidebar: 'Toggle sidebar',
contributors: false,
notFound: ['The page you are looking for does not exist or has been moved!'],
theme: defaultTheme({
logo: 'https://raw.githubusercontent.com/HyacinthBots/art/main/branding/icons/Hyacinth%20transparent%20icon.png',
contributors: false,
notFound: ['The page you are looking for does not exist or has been moved! :('],

editLink: true,
editLinkText: 'Help improve this page on GitHub',
editLinkPattern: ':repo/edit/:branch/:path',
editLink: true,
editLinkText: 'Improve this page on GitHub',
editLinkPattern: ':repo/edit/:branch/:path',

docsRepo: 'https://github.com/HyacinthBots/website',
docsBranch: 'main',
docsDir: 'docs',
repo: 'https://github.com/HyacinthBots/',
docsRepo: 'https://github.com/HyacinthBots/website',
docsBranch: 'main',
docsDir: 'docs',

navbar: [
{
text: 'Home',
link: '/'
},
{
text: 'About',
link: '/about.md'
},
{
text: 'Bots',
children: [
{
text: "Lily",
link: '/bots/lily.md'
},
{
text: "Watchdog",
link: '/bots/watchdog.md'
},
{
text: "Allium",
link: '/bots/allium.md'
}]
}
],
sidebar: [
{
text: 'Home',
link: '/',
},
{
text: 'About',
link: '/about.md'
},
{
text: 'Bots',
link: '/bots.md',
children: [
{
text: 'Lily',
link: '/bots/lily.md',
children: [
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/LilyBot'
}
]
},
{
text: 'Watchdog',
link: '/bots/watchdog.md',
children: [
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/watchdog'
}
]
},
{
text: 'Allium',
link: '/bots/allium.md',
children: [
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/allium'
}
]
}
]
}
]
}
),
navbar: [
{
text: 'Discord',
link: 'https://discord.gg/hy2329fcTZ',
},
{
text: 'Buy us a coffee!',
link: 'https://buymeacoffee.com/hyacinthbots',
}
],

plugins: [
backToTopPlugin()
]
sidebar: [
{
text: 'Home',
link: '/',
},
{
text: 'About',
link: '/about.md'
},
{
text: 'Bots',
link: '/bots.md',
prefix: "/bots/",
children: [
{
text: 'Lily',
link: 'lily/about-lily.md',
children: [
{
text: 'Commands',
link: 'lily/commands.md'
},
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/LilyBot'
}
]
},
{
text: 'Watchdog',
link: 'watchdog/about-watchdog.md',
children: [
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/watchdog'
}
]
},
{
text: 'Allium',
link: 'allium/about-allium.md',
children: [
{
text: 'GitHub',
link: 'https://github.com/HyacinthBots/allium'
}
]
}
]
}
],
sidebarDepth: 1
}),
})
4 changes: 2 additions & 2 deletions docs/.vuepress/public/manifest.webmanifest
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@
"type": "image/png"
},
{
"src": "/images/icons/android-chrome-384x384.png",
"sizes": "384x384",
"src": "/images/icons/android-chrome-512x512.png",
"sizes": "512x512",
"type": "image/png"
}
]
Expand Down
Loading

0 comments on commit a77f0e2

Please sign in to comment.