Migrate docs to VitePress
This commit is contained in:
MM20
@@ -0,0 +1,30 @@
|
||||
import { defineConfig } from 'vitepress'
|
||||
import { UserGuideSidebar } from '../docs/user-guide/sidebar.ts'
|
||||
import { DeveloperGuideSidebar } from '../docs/developer-guide/sidebar.ts'
|
||||
import { ContributorGuideSidebar } from '../docs/contributor-guide/sidebar.ts'
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
export default defineConfig({
|
||||
title: 'Kvaesitso',
|
||||
description: 'A search-focused, free and open source launcher for Android',
|
||||
themeConfig: {
|
||||
logo: '/icon.png',
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
nav: [
|
||||
{ text: 'User Guide', link: '/docs/user-guide/' },
|
||||
{ text: 'Developer Guide', link: '/docs/developer-guide/' },
|
||||
{ text: 'Contributor Guide', link: '/docs/contributor-guide/' },
|
||||
],
|
||||
|
||||
sidebar: {
|
||||
'/docs/user-guide/': UserGuideSidebar,
|
||||
'/docs/developer-guide/': DeveloperGuideSidebar,
|
||||
'/docs/contributor-guide/': ContributorGuideSidebar,
|
||||
},
|
||||
|
||||
socialLinks: [
|
||||
{ icon: 'github', link: 'https://github.com/MM2-0/Kvaesitso' },
|
||||
],
|
||||
},
|
||||
head: [['link', { rel: 'icon', href: '/icon.png' }]],
|
||||
})
|
||||
@@ -0,0 +1,50 @@
|
||||
<template>
|
||||
<div class="layout-footer">
|
||||
<div class="link-columns">
|
||||
<div class="column">
|
||||
<h4>Documentation</h4>
|
||||
<a href="/docs/user-guide">User Guide</a>
|
||||
<a href="/docs/developer-guide">Developer Guide</a>
|
||||
<a href="/docs/contributor-guide">Contributor Guide</a>
|
||||
</div>
|
||||
<div class="column">
|
||||
<h4>Legal</h4>
|
||||
<a href="/privacy-policy">Privacy Policy</a>
|
||||
<a href="/license">License</a>
|
||||
</div>
|
||||
<div class="column">
|
||||
<h4>Links</h4>
|
||||
<a href="https://github.com/MM2-0/Kvaesitso">Github</a>
|
||||
<a href="https://t.me/Kvaesitso">Telegram</a>
|
||||
</div>
|
||||
</div>
|
||||
<p class="copyright">
|
||||
Copyright © 2024 MM2-0 and the Kvaesitso contributors. Built with
|
||||
VitePress.
|
||||
</p>
|
||||
</div>
|
||||
</template>
|
||||
<style lang="scss">
|
||||
.layout-footer {
|
||||
border-top: 1px solid var(--vp-c-divider);
|
||||
padding: 2rem 2rem 4rem;
|
||||
max-width: 1100px;
|
||||
margin: 0 auto;
|
||||
.link-columns {
|
||||
display: grid;
|
||||
grid-template-columns: repeat(auto-fit, 200px);
|
||||
.column {
|
||||
display: flex;
|
||||
flex-direction: column;
|
||||
h4 {
|
||||
font-weight: 600;
|
||||
}
|
||||
}
|
||||
}
|
||||
.copyright {
|
||||
margin-top: 2rem;
|
||||
font-size: 0.8em;
|
||||
color: var(--vp-c-text);
|
||||
}
|
||||
}
|
||||
</style>
|
||||
@@ -0,0 +1,12 @@
|
||||
<script setup>
|
||||
import DefaultTheme from 'vitepress/theme'
|
||||
import Footer from './Footer.vue'
|
||||
|
||||
const { Layout } = DefaultTheme
|
||||
</script>
|
||||
|
||||
<template>
|
||||
<Layout>
|
||||
<template #doc-bottom><Footer /></template>
|
||||
</Layout>
|
||||
</template>
|
||||
@@ -0,0 +1,20 @@
|
||||
.material-symbols-rounded {
|
||||
vertical-align: text-top;
|
||||
font-size: 20px !important;
|
||||
font-variation-settings: 'FILL' 0, 'wght' 500, 'GRAD' 0, 'opsz' 20;
|
||||
}
|
||||
|
||||
.home-screenshots {
|
||||
display: grid;
|
||||
max-width: 1200px;
|
||||
margin: 4rem auto;
|
||||
gap: 2rem;
|
||||
grid-template-columns: repeat(auto-fit, 320px);
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
justify-items: center;
|
||||
img {
|
||||
width: 320px;
|
||||
border-radius: 16px;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,16 @@
|
||||
// https://vitepress.dev/guide/custom-theme
|
||||
import { h } from 'vue'
|
||||
import type { Theme } from 'vitepress'
|
||||
import DefaultTheme from 'vitepress/theme'
|
||||
import './style.css'
|
||||
import './custom.css'
|
||||
import 'material-symbols'
|
||||
import Layout from './Layout.vue'
|
||||
|
||||
export default {
|
||||
extends: DefaultTheme,
|
||||
Layout: Layout,
|
||||
enhanceApp({ app, router, siteData }) {
|
||||
// ...
|
||||
},
|
||||
} satisfies Theme
|
||||
@@ -0,0 +1,148 @@
|
||||
/**
|
||||
* 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 attched 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: #04327d;
|
||||
--vp-c-brand-2: #5596ed;
|
||||
--vp-c-brand-3: #04327d;
|
||||
--vp-c-brand-soft: #d5e3ff;
|
||||
|
||||
--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,
|
||||
#5596ed 30%,
|
||||
#04327d
|
||||
);
|
||||
|
||||
--vp-home-hero-image-background-image: transparent;
|
||||
--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;
|
||||
}
|
||||
|
||||
.dark {
|
||||
--vp-home-hero-name-background: -webkit-linear-gradient(
|
||||
120deg,
|
||||
#96c8ea 30%,
|
||||
#96c8ea
|
||||
);
|
||||
|
||||
--vp-c-brand-1: #9bcdef;
|
||||
--vp-c-brand-2: #5596ed;
|
||||
--vp-c-brand-3: #9bcdef;
|
||||
--vp-c-brand-soft: #d5e3ff;
|
||||
--vp-button-brand-text: #00344b;
|
||||
}
|
||||
Reference in New Issue
Block a user