Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
41 changes: 41 additions & 0 deletions .github/workflows/build-and-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
name: Build and Deploy VuePress Site

on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
workflow_dispatch: # Manual trigger

jobs:
build-and-deploy:
runs-on: ubuntu-latest

steps:
- name: Checkout edgemining.energy repository
uses: actions/checkout@v4
with:
path: edgemining-energy

- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '18'
cache: 'npm'
cache-dependency-path: edgemining-energy/package-lock.json

- name: Install dependencies
working-directory: edgemining-energy
run: npm ci

- name: Build VuePress site
working-directory: edgemining-energy
run: npm run docs:build

- name: Deploy to GitHub Pages
uses: peaceiris/actions-gh-pages@v1
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
publish_dir: ./.vuepress/dist
destination_dir: ./
cname: edgemining.energy
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# VuePress temp files
.vuepress/.temp/
.vuepress/.cache/
.vuepress/dist/
95 changes: 95 additions & 0 deletions .vuepress/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
import { viteBundler } from '@vuepress/bundler-vite'
import { defaultTheme } from '@vuepress/theme-default'
import { defineUserConfig } from 'vuepress'

export default defineUserConfig({
// Site configuration
lang: 'en-US',
title: 'Edge Mining',
description: 'Mine your energy - A research-driven, open-source project turning surplus energy into Bitcoin-powered digital value',

// Bundler configuration
bundler: viteBundler(),

// Theme configuration
theme: defaultTheme({
// Logo - Using the official Edge Mining organization logo
logo: '/images/logo.png',

// Repository
repo: 'https://github.com/edge-mining',
repoLabel: 'GitHub',

// Navbar configuration
navbar: [
{
text: 'Home',
link: '/',
},
{
text: 'Docs',
link: '/docs/intro.html',
},
{
text: 'Discord',
link: 'https://discord.com/invite/VQa9UY5SsS',
target: '_blank',
},
],

// Sidebar configuration
sidebar: {
'/docs/': [
{
text: 'Documentation',
children: [
'/docs/intro.md',
'/docs/about-us.md',
{
text: 'Product',
children: [
'/docs/product/product-cycle.md',
],
},
{
text: 'Modelling',
children: [
'/docs/modelling/domain-driven-architecture-overview.md',
'/docs/modelling/glossary.md',
],
},
'/docs/contribution.md',
'/docs/faq.md',
],
},
],
},

// Footer configuration
editLink: true,
editLinkText: 'Edit this page on GitHub',
lastUpdated: true,
lastUpdatedText: 'Last Updated',

// Page configuration
docsDir: 'docs',
}),

// Additional configuration
head: [
['link', { rel: 'icon', href: '/favicon.ico' }],
['link', { rel: 'apple-touch-icon', href: '/images/logo.png' }],
['meta', { name: 'theme-color', content: '#667eea' }],
['meta', { name: 'description', content: 'Edge Mining - Mine your energy. A research-driven, open-source project turning surplus energy into Bitcoin-powered digital value.' }],
['meta', { property: 'og:title', content: 'Edge Mining' }],
['meta', { property: 'og:description', content: 'Mine your energy - A research-driven, open-source project turning surplus energy into Bitcoin-powered digital value' }],
['meta', { property: 'og:url', content: 'https://edgemining.energy' }],
['meta', { property: 'og:image', content: '/images/logo.png' }],
// DaisyUI theme
['script', {}, 'document.documentElement.setAttribute("data-theme", "edge-mining")'],
],

// Development configuration
port: 8080,
open: true,
})
1 change: 1 addition & 0 deletions .vuepress/public/CNAME
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
edgemining.energy
Binary file added .vuepress/public/favicon.ico
Binary file not shown.
Binary file added .vuepress/public/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
50 changes: 50 additions & 0 deletions .vuepress/styles/daisyui.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
/* Import Tailwind CSS and DaisyUI */
@import 'tailwindcss/base';
@import 'tailwindcss/components';
@import 'tailwindcss/utilities';

/* DaisyUI theme variables */
[data-theme="edge-mining"] {
--p: 102 126 234; /* primary */
--s: 118 75 162; /* secondary */
--a: 240 147 251; /* accent */
--n: 44 62 80; /* neutral */
--b1: 255 255 255; /* base-100 */
--in: 58 191 248; /* info */
--su: 54 211 153; /* success */
--wa: 251 189 35; /* warning */
--er: 248 114 114; /* error */
}

/* Custom component styles */
.btn {
@apply px-4 py-2 rounded-lg font-semibold transition-all duration-300;
}

.btn-primary {
@apply bg-primary text-primary-content hover:bg-primary-focus;
}

.card {
@apply rounded-lg border border-base-300;
}

.card-title {
@apply text-lg font-semibold;
}

.alert {
@apply rounded-lg p-4;
}

.alert-info {
@apply bg-info text-info-content;
}

.table {
@apply w-full;
}

.table-zebra tbody tr:nth-child(even) {
@apply bg-base-200;
}
Loading