mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-08-02 19:55:18 +02:00
Migration to new documentation and information site
This commit is contained in:
Sean Morley
parent
8e5a20ec62
commit
17d8784d8c
59 changed files with 1967 additions and 11276 deletions
139
documentation/.vitepress/config.mts
Normal file
139
documentation/.vitepress/config.mts
Normal file
|
|
@ -0,0 +1,139 @@
|
|||
import { defineConfig } from "vitepress";
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
export default defineConfig({
|
||||
head: [["link", { rel: "icon", href: "/adventurelog.png" }]],
|
||||
title: "AdventureLog",
|
||||
description: "The ultimate travel companion.",
|
||||
lang: "en-US",
|
||||
|
||||
ignoreDeadLinks: [
|
||||
// ignore exact url "/playground"
|
||||
"/playground",
|
||||
// ignore all localhost links
|
||||
/^https?:\/\/localhost/,
|
||||
// ignore all links include "/repl/""
|
||||
/\/repl\//,
|
||||
// custom function, ignore all links include "ignore"
|
||||
(url) => {
|
||||
return url.toLowerCase().includes("ignore");
|
||||
},
|
||||
],
|
||||
|
||||
sitemap: {
|
||||
hostname: "https://adventurelog.app",
|
||||
},
|
||||
|
||||
themeConfig: {
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
nav: [
|
||||
{ text: "Home", link: "/" },
|
||||
{ text: "Docs", link: "/docs/intro/adventurelog_overview" },
|
||||
],
|
||||
search: {
|
||||
provider: "local",
|
||||
},
|
||||
|
||||
footer: {
|
||||
message: "AdventureLog",
|
||||
copyright:
|
||||
'Copyright © 2023-2024 <a target="_blank" href="https:/seanmorley.com">Sean Morley</a>',
|
||||
},
|
||||
|
||||
logo: "/adventurelog.png",
|
||||
|
||||
sidebar: [
|
||||
{
|
||||
text: "About AdventureLog",
|
||||
items: [
|
||||
{
|
||||
text: "AdventureLog Overview",
|
||||
link: "/docs/intro/adventurelog_overview",
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
{
|
||||
text: "Installation",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{ text: "Getting Started", link: "/docs/install/getting_started" },
|
||||
{ text: "Docker 🐋", link: "/docs/install/docker" },
|
||||
{ text: "Proxmox LXC 🐧", link: "/docs/install/proxmox_lxc" },
|
||||
{ text: "Synology NAS ☁️", link: "/docs/install/synology_nas" },
|
||||
|
||||
{
|
||||
text: "With A Reverse Proxy",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
text: "Nginx Proxy Manager",
|
||||
link: "/docs/install/nginx_proxy_manager",
|
||||
},
|
||||
{ text: "Traefik", link: "/docs/install/traefik" },
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Configuration",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
text: "Update App",
|
||||
link: "/docs/configuration/updating",
|
||||
},
|
||||
{
|
||||
text: "Disable Registration",
|
||||
link: "/docs/configuration/disable_registration",
|
||||
},
|
||||
{ text: "SMTP Email", link: "/docs/configuration/email" },
|
||||
{ text: "Umami Analytics", link: "/docs/configuration/analytics" },
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Troubleshooting",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
text: "No Images Displaying",
|
||||
link: "/docs/troubleshooting/no_images",
|
||||
},
|
||||
{
|
||||
text: "Failed to Start Nginx",
|
||||
link: "/docs/troubleshooting/nginx_failed",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Guides",
|
||||
collapsed: false,
|
||||
items: [
|
||||
{
|
||||
text: "v0.7.1 Migration Guide",
|
||||
link: "/docs/guides/v0-7-1_migration",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Changelogs",
|
||||
items: [
|
||||
{
|
||||
text: "v0.7.1",
|
||||
link: "/docs/changelogs/v0-7-1",
|
||||
},
|
||||
{
|
||||
text: "v0.7.0",
|
||||
link: "/docs/changelogs/v0-7-0",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
socialLinks: [
|
||||
{ icon: "github", link: "https://github.com/seanmorley15/AdventureLog" },
|
||||
{ icon: "discord", link: "https://discord.gg/wRbQ9Egr8C" },
|
||||
{ icon: "buymeacoffee", link: "https://buymeacoffee.com/seanmorley15" },
|
||||
],
|
||||
},
|
||||
});
|
||||
17
documentation/.vitepress/theme/index.ts
Normal file
17
documentation/.vitepress/theme/index.ts
Normal file
|
|
@ -0,0 +1,17 @@
|
|||
// https://vitepress.dev/guide/custom-theme
|
||||
import { h } from 'vue'
|
||||
import type { Theme } from 'vitepress'
|
||||
import DefaultTheme from 'vitepress/theme'
|
||||
import './style.css'
|
||||
|
||||
export default {
|
||||
extends: DefaultTheme,
|
||||
Layout: () => {
|
||||
return h(DefaultTheme.Layout, null, {
|
||||
// https://vitepress.dev/guide/extending-default-theme#layout-slots
|
||||
})
|
||||
},
|
||||
enhanceApp({ app, router, siteData }) {
|
||||
// ...
|
||||
}
|
||||
} satisfies Theme
|
||||
138
documentation/.vitepress/theme/style.css
Normal file
138
documentation/.vitepress/theme/style.css
Normal file
|
|
@ -0,0 +1,138 @@
|
|||
/**
|
||||
* 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-green-1);
|
||||
--vp-c-brand-2: var(--vp-c-green-2);
|
||||
--vp-c-brand-3: var(--vp-c-green-3);
|
||||
--vp-c-brand-soft: var(--vp-c-green-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,
|
||||
#1c913f 30%,
|
||||
#1f73f1
|
||||
);
|
||||
|
||||
--vp-home-hero-image-background-image: linear-gradient(
|
||||
-45deg,
|
||||
#1c913f 50%,
|
||||
#1f73f1 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;
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue