diff options
Diffstat (limited to 'communities/red-right-hand/vitepress/.vitepress/theme')
4 files changed, 321 insertions, 0 deletions
diff --git a/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadAuto.vue b/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadAuto.vue new file mode 100644 index 0000000..5796198 --- /dev/null +++ b/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadAuto.vue @@ -0,0 +1,60 @@ +<script setup lang="ts"> +import { onBeforeMount, ref } from "vue"; + +const offlineReady = ref(false); +function onOfflineReady() { + offlineReady.value = true; +} +async function close() { + offlineReady.value = false; +} + +onBeforeMount(async () => { + const { registerSW } = await import("virtual:pwa-register"); + registerSW({ + immediate: true, + onOfflineReady, + onRegistered() { + console.info("Service Worker registered"); + }, + onRegisterError(e) { + console.error("Service Worker registration error!", e); + }, + }); +}); +</script> + +<template> + <template v-if="offlineReady"> + <div class="pwa-toast" role="alertdialog" aria-labelledby="pwa-message"> + <div id="pwa-message" class="mb-3">App ready to work offline</div> + <button type="button" class="pwa-cancel" @click="close">Close</button> + </div> + </template> +</template> + +<style> +.pwa-toast { + position: fixed; + right: 0; + bottom: 0; + margin: 16px; + padding: 12px; + border: 1px solid #8885; + border-radius: 4px; + z-index: 100; + text-align: left; + box-shadow: 3px 4px 5px 0 #8885; + background-color: white; +} +.pwa-toast #pwa-message { + margin-bottom: 8px; +} +.pwa-toast button { + border: 1px solid #8885; + outline: none; + margin-right: 5px; + border-radius: 2px; + padding: 3px 10px; +} +</style> diff --git a/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadPrompt.vue b/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadPrompt.vue new file mode 100644 index 0000000..6e60fb3 --- /dev/null +++ b/communities/red-right-hand/vitepress/.vitepress/theme/components/ReloadPrompt.vue @@ -0,0 +1,83 @@ +<script setup lang="ts"> +import { onBeforeMount, ref } from "vue"; + +const offlineReady = ref(false); +const needRefresh = ref(false); + +let updateServiceWorker: (() => Promise<void>) | undefined; + +function onOfflineReady() { + offlineReady.value = true; +} +function onNeedRefresh() { + needRefresh.value = true; +} +async function close() { + offlineReady.value = false; + needRefresh.value = false; +} + +onBeforeMount(async () => { + const { registerSW } = await import("virtual:pwa-register"); + updateServiceWorker = registerSW({ + immediate: true, + onOfflineReady, + onNeedRefresh, + onRegistered() { + console.info("Service Worker registered"); + }, + onRegisterError(e) { + console.error("Service Worker registration error!", e); + }, + }); +}); +</script> + +<template> + <template v-if="offlineReady || needRefresh"> + <div class="pwa-toast" role="alertdialog" aria-labelledby="pwa-message"> + <div id="pwa-message" class="mb-3"> + {{ + offlineReady + ? "App ready to work offline" + : "New content available, click the reload button to update." + }} + </div> + <button + v-if="needRefresh" + type="button" + class="pwa-refresh" + @click="updateServiceWorker?.()" + > + Reload + </button> + <button type="button" class="pwa-cancel" @click="close">Close</button> + </div> + </template> +</template> + +<style> +.pwa-toast { + position: fixed; + right: 0; + bottom: 0; + margin: 16px; + padding: 12px; + border: 1px solid #8885; + border-radius: 4px; + z-index: 100; + text-align: left; + box-shadow: 3px 4px 5px 0 #8885; + background-color: white; +} +.pwa-toast #pwa-message { + margin-bottom: 8px; +} +.pwa-toast button { + border: 1px solid #8885; + outline: none; + margin-right: 5px; + border-radius: 2px; + padding: 3px 10px; +} +</style> diff --git a/communities/red-right-hand/vitepress/.vitepress/theme/index.js b/communities/red-right-hand/vitepress/.vitepress/theme/index.js new file mode 100644 index 0000000..f8f80fc --- /dev/null +++ b/communities/red-right-hand/vitepress/.vitepress/theme/index.js @@ -0,0 +1,37 @@ +// https://vitepress.dev/guide/custom-theme +import { h } from "vue"; +import DefaultTheme from "vitepress/theme"; +import "./style.css"; + +import ReloadPrompt from "./components/ReloadPrompt.vue"; + +import { enhanceAppWithTabs } from "vitepress-plugin-tabs/client"; + +/** @type {import('vitepress').Theme} */ +export default { + extends: DefaultTheme, + Layout: () => { + return h(DefaultTheme.Layout, null, { + // https://vitepress.dev/guide/extending-default-theme#layout-slots + "doc-before": () => + h( + "p", + { + style: { + backgroundColor: "yellow", + color: "#111", + padding: "0.75rem 1rem", + fontWeight: "600", + display: "block", + marginBottom: "1rem", + }, + }, + "WARNING: This documentation is very early and incomplete. It may contain inaccurate or missing content. Do not rely on this information yet. For official information, please refer to the classified channels or contact your commanding officer.", + ), + "layout-bottom": () => h(ReloadPrompt), + }); + }, + enhanceApp({ app, router, siteData }) { + enhanceAppWithTabs(app); + }, +}; diff --git a/communities/red-right-hand/vitepress/.vitepress/theme/style.css b/communities/red-right-hand/vitepress/.vitepress/theme/style.css new file mode 100644 index 0000000..346a066 --- /dev/null +++ b/communities/red-right-hand/vitepress/.vitepress/theme/style.css @@ -0,0 +1,141 @@ +/** + * 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 an 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: #d60404; + --vp-c-brand-2: #800505; + --vp-c-brand-3: red; + --vp-c-brand-soft: #240101; + + --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( + 135deg, + var(--vp-c-brand-1) 50%, + var(--vp-c-brand-2) + ); + + --vp-home-hero-image-background-image: linear-gradient( + 315deg, + var(--vp-c-brand-1) 50%, + var(--vp-c-brand-2) + ); + --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); +} + +/* all paragraphs should be justified */ +p { + text-align: justify; +} + +/* replace fonts */ +:root { + --vp-font-family-base: "Inter"; + --vp-font-family-mono: "Fira Code"; +} |