Added a bunch of boilerplate and started working on the flash documentation

This commit is contained in:
Relism
2024-12-15 03:17:07 +01:00
parent 0d2be4eecf
commit 308cf0971d
25 changed files with 597 additions and 94 deletions
+2 -2
View File
@@ -1,4 +1,4 @@
node_modules node_modules
.vitepress/dist base/.vitepress/dist
.vitepress/cache base/.vitepress/cache
dist dist
+15
View File
@@ -0,0 +1,15 @@
<component name="InspectionProjectProfileManager">
<profile version="1.0">
<option name="myName" value="Project Default" />
<inspection_tool class="HtmlUnknownAttribute" enabled="true" level="WARNING" enabled_by_default="true">
<option name="myValues">
<value>
<list size="1">
<item index="0" class="java.lang.String" itemvalue="setup" />
</list>
</value>
</option>
<option name="myCustomValuesEnabled" value="true" />
</inspection_tool>
</profile>
</component>
+6
View File
@@ -0,0 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<project version="4">
<component name="JavaScriptLibraryMappings">
<includedPredefinedLibrary name="Node.js Core" />
</component>
</project>
+8 -27
View File
@@ -1,28 +1,9 @@
import { defineConfig } from 'vitepress' import sidebarConfig from '../composer.js'
// https://vitepress.dev/reference/site-config export default {
export default defineConfig({ themeConfig: {
title: "pixeldocs", siteTitle: 'Pixel Services Docs',
description: "Documentation for the PixelServices projects", logo: 'https://static.pixel-services.com/static/assets/pservices_logo.png',
themeConfig: { sidebar: sidebarConfig
// https://vitepress.dev/reference/default-theme-config }
nav: [ }
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],
sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
})
-49
View File
@@ -1,49 +0,0 @@
---
outline: deep
---
# Runtime API Examples
This page demonstrates usage of some of the runtime APIs provided by VitePress.
The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
```md
<script setup>
import { useData } from 'vitepress'
const { theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
```
<script setup>
import { useData } from 'vitepress'
const { site, theme, page, frontmatter } = useData()
</script>
## Results
### Theme Data
<pre>{{ theme }}</pre>
### Page Data
<pre>{{ page }}</pre>
### Page Frontmatter
<pre>{{ frontmatter }}</pre>
## More
Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).
+29
View File
@@ -0,0 +1,29 @@
import fs from 'fs'
import path from 'path'
import { fileURLToPath } from 'url'
const __filename = fileURLToPath(import.meta.url)
const __dirname = path.dirname(__filename)
console.log('Starting composer.js execution')
const projects = ['flash', 'mobot', 'serverlibraries']
const sidebarConfig = {}
projects.forEach(project => {
const sidebarPath = path.resolve(__dirname, `./${project}/config/sidebar.json`)
console.log(`Checking for sidebar.json in ${project}`)
if (fs.existsSync(sidebarPath)) {
console.log(`Found sidebar.json in ${project}`)
const sidebar = JSON.parse(fs.readFileSync(sidebarPath, 'utf-8'))
Object.assign(sidebarConfig, sidebar)
} else {
console.log(`sidebar.json not found in ${project}`)
}
})
// Log the contents of sidebarConfig for debugging
console.log('Final sidebarConfig:', JSON.stringify(sidebarConfig, null, 2))
export default sidebarConfig
+32
View File
@@ -0,0 +1,32 @@
import { defineConfig } from 'vitepress'
export default defineConfig({
base: "/flash/",
title: "pixeldocs",
description: "Documentation for the PixelServices projects",
cleanUrls: true,
outDir: '../dist/flash',
themeConfig: {
sidebar: {
'/guide/': [
{
text: 'Guide',
items: [
{ text: 'Introduction', link: '/guide/' },
{ text: 'Getting Started', link: '/guide/getting-started' }
]
}
],
'/': [
{
text: 'General',
items: [
{ text: 'Home', link: '/' },
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'API Examples', link: '/api-examples' }
]
}
]
}
}
})
+10
View File
@@ -0,0 +1,10 @@
{
"/flash/": [
{
"text": "Flash Documentation",
"items": [
{ "text": "Getting Started", "link": "/flash" }
]
}
]
}
+72
View File
@@ -0,0 +1,72 @@
<script setup>
import { ref, onMounted } from 'vue';
const latestVersion = ref('');
onMounted(async () => {
try {
const response = await fetch('https://maven.pixel-services.com/api/maven/details/releases/com/pixelservices/flash');
const data = await response.json();
const versions = data.files.filter(file => file.type === 'DIRECTORY').map(file => file.name);
latestVersion.value = versions.sort().pop();
} catch (error) {
console.error('Error fetching latest version:', error);
latestVersion.value = 'Error fetching version';
}
})
</script>
# ⚡ Getting Started
This page provides installation instructions for the latest version of the `flash` library from Pixel Services.
## Installation
### Maven (pom.xml)
1. Add the repository :
```xml
<repositories>
<repository>
<id>pixel-services</id>
<name>Pixel Services</name>
<url>https://maven.pixel-services.com/repository</url>
</repository>
</repositories>
```
2. And the dependency :
```xml
<dependencies>
<dependency>
<groupId>com.pixelservices</groupId>
<artifactId>flash</artifactId>
<version>{{ latestVersion }}</version>
</dependency>
</dependencies>
```
### Gradle (build.gradle)
1. Add the repository :
```groovy
repositories {
maven {
url "https://maven.pixel-services.com/repository"
}
}
```
2. And the dependency :
```groovy
dependencies {
implementation 'com.pixelservices:flash:{{ latestVersion }}'
}
```
<div>
⚡ Latest version:
<a href="'https://maven.pixel-services.com/#/releases/com/pixelservices/flash'" style="text-decoration: underline; color: #007bff;">
<strong>{{ latestVersion }}</strong>
</a>
</div>
+16 -13
View File
@@ -3,23 +3,26 @@
layout: home layout: home
hero: hero:
name: "pixeldocs" name: "Pixel Services Documentation"
text: "Documentation for the PixelServices projects" text: ""
tagline: My great project tagline tagline: "Explore the documentation for all public Pixel Services projects"
actions: actions:
- theme: brand - theme: brand
text: Markdown Examples text: Support Us
link: /markdown-examples link: https://buymeacoffee.com/pixelservices
- theme: alt - theme: alt
text: API Examples text: Check out our Github
link: /api-examples link: https://github.com/Pixel-Services
features: features:
- title: Feature A - title: Flash
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit details: Simple, modern and fast expressive web framework written in Java.
- title: Feature B link: /flash
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit - title: ServerLibraries
- title: Feature C details: A Library made to ease server-side Fabric mod development.
details: Lorem ipsum dolor sit amet, consectetur adipiscing elit link: /serverlibraries
- title: MoBot
details: A Modular Discord Bot with a simple but efficent API.
link: /mobot
--- ---
+31
View File
@@ -0,0 +1,31 @@
import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
base: "/mobot/",
title: "pixeldocs",
description: "Documentation for the PixelServices projects",
cleanUrls: true,
outDir: '../dist/mobot',
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],
sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
})
+17
View File
@@ -0,0 +1,17 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import DefaultTheme from 'vitepress/theme'
import './style.css'
/** @type {import('vitepress').Theme} */
export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
},
enhanceApp({ app, router, siteData }) {
// ...
}
}
+139
View File
@@ -0,0 +1,139 @@
/**
* Customize default theme styling by overriding CSS variables:
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
*/
/**
* Colors
*
* Each colors have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
* - `XXX-3`: The color for solid background, such as bg color of the button.
* It must satisfy the contrast ratio with pure white (#ffffff) text on
* top of it.
*
* - `XXX-soft`: The color used for subtle background such as custom container
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
* on top of it.
*
* The soft color must be semi transparent alpha channel. This is crucial
* because it allows adding multiple "soft" colors on top of each other
* to create a accent, such as when having inline code block inside
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attached to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
*
* - `tip`: Used to indicate useful information. The default theme uses the
* brand color for this by default.
*
* - `warning`: Used to indicate warning to the users. Used in custom
* container, badges, etc.
*
* - `danger`: Used to show error, or dangerous message to the users. Used
* in custom container, badges, etc.
* -------------------------------------------------------------------------- */
:root {
--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);
--vp-c-brand-1: var(--vp-c-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-soft);
--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
--vp-c-tip-3: var(--vp-c-brand-3);
--vp-c-tip-soft: var(--vp-c-brand-soft);
--vp-c-warning-1: var(--vp-c-yellow-1);
--vp-c-warning-2: var(--vp-c-yellow-2);
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);
--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
}
/**
* Component: Button
* -------------------------------------------------------------------------- */
:root {
--vp-button-brand-border: transparent;
--vp-button-brand-text: var(--vp-c-white);
--vp-button-brand-bg: var(--vp-c-brand-3);
--vp-button-brand-hover-border: transparent;
--vp-button-brand-hover-text: var(--vp-c-white);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-border: transparent;
--vp-button-brand-active-text: var(--vp-c-white);
--vp-button-brand-active-bg: var(--vp-c-brand-1);
}
/**
* Component: Home
* -------------------------------------------------------------------------- */
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
);
--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}
@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}
@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}
/**
* Component: Custom Block
* -------------------------------------------------------------------------- */
:root {
--vp-custom-block-tip-border: transparent;
--vp-custom-block-tip-text: var(--vp-c-text-1);
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
}
/**
* Component: Algolia
* -------------------------------------------------------------------------- */
.DocSearch {
--docsearch-primary-color: var(--vp-c-brand-1) !important;
}
+10
View File
@@ -0,0 +1,10 @@
{
"/mobot/": [
{
"text": "MoBot Documentation",
"items": [
{ "text": "Getting Started", "link": "/mobot" }
]
}
]
}
View File
+1 -1
View File
@@ -1,5 +1,5 @@
{ {
"name": "pixeldocs", "name": "PixelDocs",
"lockfileVersion": 3, "lockfileVersion": 3,
"requires": true, "requires": true,
"packages": { "packages": {
+6 -1
View File
@@ -3,9 +3,14 @@
"vitepress": "^1.5.0", "vitepress": "^1.5.0",
"vue": "^3.5.13" "vue": "^3.5.13"
}, },
"type": "module",
"scripts": { "scripts": {
"docs:dev": "vitepress dev", "docs:dev": "vitepress dev",
"docs:build": "vitepress build", "docs:build": "vitepress build",
"docs:preview": "vitepress preview" "docs:preview": "vitepress preview",
"build:all": "npm run build:base && npm run build:flash && npm run build:mobot",
"build:base": "vitepress build base",
"build:flash": "vitepress build flash",
"build:mobot": "vitepress build mobot"
} }
} }
+31
View File
@@ -0,0 +1,31 @@
import { defineConfig } from 'vitepress'
// https://vitepress.dev/reference/site-config
export default defineConfig({
base: "/serverlibraries/",
title: "pixeldocs",
description: "Documentation for the PixelServices projects",
cleanUrls: true,
outDir: '../dist/serverlibraries',
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
{ text: 'Home', link: '/' },
{ text: 'Examples', link: '/markdown-examples' }
],
sidebar: [
{
text: 'Examples',
items: [
{ text: 'Markdown Examples', link: '/markdown-examples' },
{ text: 'Runtime API Examples', link: '/api-examples' }
]
}
],
socialLinks: [
{ icon: 'github', link: 'https://github.com/vuejs/vitepress' }
]
}
})
+17
View File
@@ -0,0 +1,17 @@
// https://vitepress.dev/guide/custom-theme
import { h } from 'vue'
import DefaultTheme from 'vitepress/theme'
import './style.css'
/** @type {import('vitepress').Theme} */
export default {
extends: DefaultTheme,
Layout: () => {
return h(DefaultTheme.Layout, null, {
// https://vitepress.dev/guide/extending-default-theme#layout-slots
})
},
enhanceApp({ app, router, siteData }) {
// ...
}
}
+139
View File
@@ -0,0 +1,139 @@
/**
* Customize default theme styling by overriding CSS variables:
* https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css
*/
/**
* Colors
*
* Each colors have exact same color scale system with 3 levels of solid
* colors with different brightness, and 1 soft color.
*
* - `XXX-1`: The most solid color used mainly for colored text. It must
* satisfy the contrast ratio against when used on top of `XXX-soft`.
*
* - `XXX-2`: The color used mainly for hover state of the button.
*
* - `XXX-3`: The color for solid background, such as bg color of the button.
* It must satisfy the contrast ratio with pure white (#ffffff) text on
* top of it.
*
* - `XXX-soft`: The color used for subtle background such as custom container
* or badges. It must satisfy the contrast ratio when putting `XXX-1` colors
* on top of it.
*
* The soft color must be semi transparent alpha channel. This is crucial
* because it allows adding multiple "soft" colors on top of each other
* to create a accent, such as when having inline code block inside
* custom containers.
*
* - `default`: The color used purely for subtle indication without any
* special meanings attached to it such as bg color for menu hover state.
*
* - `brand`: Used for primary brand colors, such as link text, button with
* brand theme, etc.
*
* - `tip`: Used to indicate useful information. The default theme uses the
* brand color for this by default.
*
* - `warning`: Used to indicate warning to the users. Used in custom
* container, badges, etc.
*
* - `danger`: Used to show error, or dangerous message to the users. Used
* in custom container, badges, etc.
* -------------------------------------------------------------------------- */
:root {
--vp-c-default-1: var(--vp-c-gray-1);
--vp-c-default-2: var(--vp-c-gray-2);
--vp-c-default-3: var(--vp-c-gray-3);
--vp-c-default-soft: var(--vp-c-gray-soft);
--vp-c-brand-1: var(--vp-c-indigo-1);
--vp-c-brand-2: var(--vp-c-indigo-2);
--vp-c-brand-3: var(--vp-c-indigo-3);
--vp-c-brand-soft: var(--vp-c-indigo-soft);
--vp-c-tip-1: var(--vp-c-brand-1);
--vp-c-tip-2: var(--vp-c-brand-2);
--vp-c-tip-3: var(--vp-c-brand-3);
--vp-c-tip-soft: var(--vp-c-brand-soft);
--vp-c-warning-1: var(--vp-c-yellow-1);
--vp-c-warning-2: var(--vp-c-yellow-2);
--vp-c-warning-3: var(--vp-c-yellow-3);
--vp-c-warning-soft: var(--vp-c-yellow-soft);
--vp-c-danger-1: var(--vp-c-red-1);
--vp-c-danger-2: var(--vp-c-red-2);
--vp-c-danger-3: var(--vp-c-red-3);
--vp-c-danger-soft: var(--vp-c-red-soft);
}
/**
* Component: Button
* -------------------------------------------------------------------------- */
:root {
--vp-button-brand-border: transparent;
--vp-button-brand-text: var(--vp-c-white);
--vp-button-brand-bg: var(--vp-c-brand-3);
--vp-button-brand-hover-border: transparent;
--vp-button-brand-hover-text: var(--vp-c-white);
--vp-button-brand-hover-bg: var(--vp-c-brand-2);
--vp-button-brand-active-border: transparent;
--vp-button-brand-active-text: var(--vp-c-white);
--vp-button-brand-active-bg: var(--vp-c-brand-1);
}
/**
* Component: Home
* -------------------------------------------------------------------------- */
:root {
--vp-home-hero-name-color: transparent;
--vp-home-hero-name-background: -webkit-linear-gradient(
120deg,
#bd34fe 30%,
#41d1ff
);
--vp-home-hero-image-background-image: linear-gradient(
-45deg,
#bd34fe 50%,
#47caff 50%
);
--vp-home-hero-image-filter: blur(44px);
}
@media (min-width: 640px) {
:root {
--vp-home-hero-image-filter: blur(56px);
}
}
@media (min-width: 960px) {
:root {
--vp-home-hero-image-filter: blur(68px);
}
}
/**
* Component: Custom Block
* -------------------------------------------------------------------------- */
:root {
--vp-custom-block-tip-border: transparent;
--vp-custom-block-tip-text: var(--vp-c-text-1);
--vp-custom-block-tip-bg: var(--vp-c-brand-soft);
--vp-custom-block-tip-code-bg: var(--vp-c-brand-soft);
}
/**
* Component: Algolia
* -------------------------------------------------------------------------- */
.DocSearch {
--docsearch-primary-color: var(--vp-c-brand-1) !important;
}
+10
View File
@@ -0,0 +1,10 @@
{
"/serverlibraries/": [
{
"text": "ServerLibraries Documentation",
"items": [
{ "text": "Getting Started", "link": "/serverlibraries" }
]
}
]
}
+5
View File
@@ -0,0 +1,5 @@
---
# https://vitepress.dev/reference/default-theme-home-page
layout: doc
---