mirror of
https://gitee.com/mirrors_PX4/PX4-Autopilot.git
synced 2026-10-26 03:03:34 +08:00
Move PX4 Guide source into /docs (#24490)
* Add vitepress tree * Update existing workflows so they dont trigger on changes in the docs path * Add nojekyll, package.json, LICENCE etc * Add crowdin docs upload/download scripts * Add docs flaw checker workflows * Used docs prefix for docs workflows * Crowdin obvious fixes * ci: docs move to self hosted runner runs on a beefy server for faster builds Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: don't run build action for docs or ci changes Signed-off-by: Ramon Roche <mrpollo@gmail.com> * ci: update runners Signed-off-by: Ramon Roche <mrpollo@gmail.com> * Add docs/en * Add docs assets and scripts * Fix up editlinks to point to PX4 sources * Download just the translations that are supported * Add translation sources for zh, uk, ko * Update latest tranlsation and uorb graphs * update vitepress to latest --------- Signed-off-by: Ramon Roche <mrpollo@gmail.com> Co-authored-by: Ramon Roche <mrpollo@gmail.com>
This commit is contained in:
Hamish Willee
co-authored by
Ramon Roche
Ramon Roche
parent
8e6d2ebe4a
commit
88d623bedb
@@ -0,0 +1,248 @@
|
||||
import { defineConfig } from "vitepress";
|
||||
const getSidebar = require("./get_sidebar.js");
|
||||
|
||||
import openEditor from "open-editor"; // Open file locally via edit
|
||||
|
||||
// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
|
||||
import tabsPlugin from "@red-asuka/vitepress-plugin-tabs";
|
||||
|
||||
// https://vitepress.dev/reference/site-config
|
||||
export default defineConfig({
|
||||
title: "PX4 Guide (main)",
|
||||
description: "PX4 User and Developer Guide",
|
||||
base: process.env.BRANCH_NAME
|
||||
? "/" + process.env.BRANCH_NAME + "/"
|
||||
: "/px4_user_guide/",
|
||||
srcExclude: [
|
||||
"de/**/*.md",
|
||||
"ja/**/*.md",
|
||||
"ru/**/*.md",
|
||||
"tr/**/*.md",
|
||||
//"kr/**/*.md",
|
||||
//"zh/**/*.md",
|
||||
//"uk/**/*.md",
|
||||
"**/_*.md", //Remove source docs that start with "_" (included/not rendered)
|
||||
],
|
||||
ignoreDeadLinks: true,
|
||||
markdown: {
|
||||
math: true,
|
||||
config: (md) => {
|
||||
// use more markdown-it plugins!
|
||||
tabsPlugin(md); //https://github.com/Red-Asuka/vitepress-plugin-tabs
|
||||
},
|
||||
},
|
||||
|
||||
vite: {
|
||||
plugins: [
|
||||
{
|
||||
// Open file locally via edit
|
||||
name: "open-in-editor",
|
||||
configureServer(server) {
|
||||
server.middlewares.use("/__open-in-editor", (req, res, next) => {
|
||||
if (!req.url) return next();
|
||||
const q = new URL(req.url, "http://a.com").searchParams;
|
||||
const file = q.get("file");
|
||||
if (!file) return next();
|
||||
const line = Number.parseInt(q.get("line")) || 1;
|
||||
const column = Number.parseInt(q.get("column")) || 1;
|
||||
// Open editor if EDITOR environment variable is set
|
||||
if (typeof process.env.EDITOR !== "undefined") {
|
||||
openEditor([{ file, line, column }]);
|
||||
} else {
|
||||
console.warn(
|
||||
"EDITOR environment variable is not set. Skipping opening file."
|
||||
);
|
||||
}
|
||||
res.statusCode = 204;
|
||||
res.end();
|
||||
});
|
||||
},
|
||||
},
|
||||
],
|
||||
},
|
||||
|
||||
locales: {
|
||||
en: {
|
||||
label: "English",
|
||||
// other locale specific properties...
|
||||
themeConfig: {
|
||||
sidebar: getSidebar.sidebar("en"),
|
||||
editLink: {
|
||||
text:
|
||||
/* We get a github link if CI env is defined,
|
||||
or if it isn't defined and a local editor isn't defined) */
|
||||
typeof process.env.CI !== "undefined" ||
|
||||
typeof process.env.EDITOR === "undefined"
|
||||
? "Edit on GitHub"
|
||||
: "Open in your editor",
|
||||
pattern:
|
||||
typeof process.env.CI !== "undefined" ||
|
||||
typeof process.env.EDITOR === "undefined"
|
||||
? ({ filePath, frontmatter }) => {
|
||||
if (frontmatter.newEditLink) {
|
||||
//newEditLink defines a frontmatter key you can use to append a path to main
|
||||
return `https://github.com/PX4/PX4-Autopilot/edit/main/${frontmatter.newEditLink}`;
|
||||
} else {
|
||||
return `https://github.com/PX4/PX4-Autopilot/edit/main/${filePath}`;
|
||||
}
|
||||
}
|
||||
: (c) =>
|
||||
`${
|
||||
window.location.origin
|
||||
}/__open-in-editor?file=${encodeURIComponent(c.filePath)}`,
|
||||
},
|
||||
},
|
||||
},
|
||||
|
||||
zh: {
|
||||
label: "中文 (Chinese)",
|
||||
lang: "zh-CN", // optional, will be added as `lang` attribute on `html` tag
|
||||
themeConfig: {
|
||||
sidebar: getSidebar.sidebar("zh"),
|
||||
},
|
||||
// other locale specific properties...
|
||||
},
|
||||
ko: {
|
||||
label: "한국어 (Korean)",
|
||||
lang: "ko-KR", // optional, will be added as `lang` attribute on `html` tag
|
||||
themeConfig: {
|
||||
sidebar: getSidebar.sidebar("ko"),
|
||||
},
|
||||
|
||||
// other locale specific properties...
|
||||
},
|
||||
|
||||
uk: {
|
||||
label: "Мови (Ukrainian)",
|
||||
lang: "uk-UA", // optional, will be added as `lang` attribute on `html` tag
|
||||
themeConfig: {
|
||||
sidebar: getSidebar.sidebar("uk"),
|
||||
},
|
||||
|
||||
// other locale specific properties...
|
||||
},
|
||||
},
|
||||
//Logs every page loaded on build. Good way to catch errors not caught by other things.
|
||||
async transformPageData(pageData, { siteConfig }) {
|
||||
console.log(pageData.filePath);
|
||||
},
|
||||
|
||||
//
|
||||
|
||||
themeConfig: {
|
||||
// https://vitepress.dev/reference/default-theme-config
|
||||
logo: "/px4-logo.svg",
|
||||
sidebar: getSidebar.sidebar("en"),
|
||||
|
||||
editLink: {
|
||||
pattern: "https://crowdin.com/project/px4-user-guide",
|
||||
text: "Edit translation on Crowdin",
|
||||
},
|
||||
|
||||
search: {
|
||||
provider: "local",
|
||||
/*
|
||||
provider: process.env.BRANCH_NAME ? "algolia" : "local",
|
||||
options: {
|
||||
appId: "HHWW7I44JO",
|
||||
apiKey: "48919e1dffc6e0ce4c0d6331343d2c0e",
|
||||
indexName: "px4",
|
||||
searchParameters: {
|
||||
facetFilters: [`version:${process.env.BRANCH_NAME}`],
|
||||
},
|
||||
},
|
||||
*/
|
||||
},
|
||||
|
||||
nav: [
|
||||
{
|
||||
text: "PX4",
|
||||
items: [
|
||||
{
|
||||
text: "Website",
|
||||
link: "https://px4.io/",
|
||||
ariaLabel: "PX4 website link",
|
||||
},
|
||||
{
|
||||
text: "Autopilot Source Code",
|
||||
link: "https://github.com/PX4/PX4-Autopilot",
|
||||
},
|
||||
{
|
||||
text: "Docs Source Code",
|
||||
link: "https://github.com/PX4/PX4-Autopilot/docs/",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Dronecode",
|
||||
items: [
|
||||
{
|
||||
text: "QGroundControl",
|
||||
link: "http://qgroundcontrol.com/",
|
||||
},
|
||||
{
|
||||
text: "MAVSDK",
|
||||
link: "https://mavsdk.mavlink.io/",
|
||||
},
|
||||
{
|
||||
text: "MAVLINK",
|
||||
link: "https://mavlink.io/en/",
|
||||
},
|
||||
{
|
||||
text: "QGroundControl Guide",
|
||||
link: "https://docs.qgroundcontrol.com/master/en/qgc-user-guide/",
|
||||
},
|
||||
{
|
||||
text: "Dronecode Camera Manager",
|
||||
link: "https://camera-manager.dronecode.org/en/",
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
text: "Support",
|
||||
link: "https://docs.px4.io/main/en/contribute/support.html",
|
||||
},
|
||||
{
|
||||
text: "Version",
|
||||
items: [
|
||||
{ text: "main", link: "https://docs.px4.io/main/en/" },
|
||||
{ text: "v1.15", link: "https://docs.px4.io/v1.15/en/" },
|
||||
{ text: "v1.14", link: "https://docs.px4.io/v1.14/en/" },
|
||||
{ text: "v1.13", link: "https://docs.px4.io/v1.13/en/" },
|
||||
{ text: "v1.12", link: "https://docs.px4.io/v1.12/en/" },
|
||||
{ text: "v1.11", link: "https://docs.px4.io/v1.11/en/" },
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
socialLinks: [
|
||||
{ icon: "github", link: "https://github.com/PX4/PX4-Autopilot" },
|
||||
],
|
||||
},
|
||||
|
||||
head: [
|
||||
[
|
||||
"script",
|
||||
{
|
||||
async: "",
|
||||
src: "https://www.googletagmanager.com/gtag/js?id=G-91EWVWRQ93",
|
||||
},
|
||||
],
|
||||
[
|
||||
"script",
|
||||
{},
|
||||
`window.dataLayer = window.dataLayer || [];
|
||||
function gtag(){dataLayer.push(arguments);}
|
||||
gtag('js', new Date());
|
||||
gtag('config', 'G-91EWVWRQ93');`,
|
||||
],
|
||||
],
|
||||
|
||||
vue: {
|
||||
template: {
|
||||
compilerOptions: {
|
||||
isCustomElement: (tag) => tag === "lite-youtube",
|
||||
},
|
||||
},
|
||||
},
|
||||
});
|
||||
@@ -0,0 +1,267 @@
|
||||
// .vuepress/get_sidebar.js
|
||||
|
||||
import path from "path";
|
||||
import fs from "fs";
|
||||
import readline from "readline";
|
||||
|
||||
function getEntryArray(parent) {
|
||||
let returnEntryArray = null;
|
||||
//console.log("getEntryArray(): parent");
|
||||
//console.log(parent);
|
||||
//Gets returns the child array
|
||||
//if (parent === "undefined") {
|
||||
// return [];
|
||||
//}
|
||||
|
||||
if (Array.isArray(parent)) {
|
||||
//This parent is an array, so return it (it is the sidebar top level)
|
||||
returnEntryArray = parent;
|
||||
//console.log("isArray");
|
||||
}
|
||||
parent.items = parent?.items ? parent.items : [];
|
||||
//console.log("isNotArray");
|
||||
//console.log("returnEntryArray:");
|
||||
returnEntryArray = parent.items;
|
||||
//console.log(returnEntryArray);
|
||||
return returnEntryArray;
|
||||
}
|
||||
|
||||
function parseGitbookSidebarToVuepress(sidebarContent, lang) {
|
||||
const lines = sidebarContent.split("\n");
|
||||
|
||||
const newSidebar = [];
|
||||
|
||||
let first_iteration = true;
|
||||
let indent_divider = 0;
|
||||
|
||||
const parents = [];
|
||||
//console.log("parents - empty after creaton");
|
||||
//console.log(parents);
|
||||
|
||||
const topLevelParent = {
|
||||
title: "DUMMY",
|
||||
path: "DUMMY",
|
||||
//level: "0",
|
||||
//items: [],
|
||||
};
|
||||
topLevelParent.items = [];
|
||||
//console.log("topLevelParent - empty after creaton");
|
||||
//console.log(topLevelParent);
|
||||
|
||||
parents.push(topLevelParent); // So last item is always the sidebar
|
||||
//console.log("parents after pushing topLevelParent:");
|
||||
//console.log(parents);
|
||||
|
||||
let current_parent;
|
||||
|
||||
let lastlevel = 0;
|
||||
let last_item;
|
||||
|
||||
//let currentSection;
|
||||
//let currentLevel = 0;
|
||||
|
||||
lines.forEach((line) => {
|
||||
if (line.startsWith("#") || line.trim() === "") {
|
||||
// Ignore lines that start with "#" or are empty
|
||||
// Note, we should perhaps create sections for these. TBD.
|
||||
return;
|
||||
}
|
||||
|
||||
//console.log("DEBUG: Line: " + line);
|
||||
|
||||
let regex = /(\s*?)[\*-]\s\[(.*?)\]\((.*?)\)/g;
|
||||
|
||||
let indent_level = "";
|
||||
let link_title = "";
|
||||
let link_url = "";
|
||||
let link_path = "";
|
||||
|
||||
try {
|
||||
//console.log(`DEBUG: Lastitem at start: ${JSON.stringify(last_item)}`);
|
||||
let match = regex.exec(line);
|
||||
//console.log('0: '+ match[0])
|
||||
indent_level = match[1].length;
|
||||
link_title = match[2];
|
||||
link_url = match[3].trim();
|
||||
link_path = link_url;
|
||||
} catch (err) {
|
||||
//Just skip empty lines that don't match
|
||||
console.log(err);
|
||||
console.log("DEBUG: Couldn't match line, skip line using return");
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
/*
|
||||
if (link_url.endsWith("README.md")) {
|
||||
link_url = link_url.replace("README.md", "");
|
||||
}
|
||||
*/
|
||||
if (link_url.endsWith(".md")) {
|
||||
link_url = link_url.replace(".md", ".html");
|
||||
//link_path = link_path.replace(".md", ".html");
|
||||
}
|
||||
|
||||
if (!link_url.startsWith("http")) {
|
||||
if (lang) {
|
||||
link_url = `/${lang}/${link_url}`;
|
||||
} else {
|
||||
link_url = `/${link_url}`;
|
||||
}
|
||||
}
|
||||
|
||||
//Tidy up some of the title escaping that isn't used by VuePress
|
||||
link_title = link_title.replace("\\(", "(");
|
||||
link_title = link_title.replace("\\)", ")");
|
||||
link_title = link_title.replace("\\_", "_");
|
||||
|
||||
//set indent_divider level (easier to think in levels, numbers of zero prefixes)
|
||||
if ((indent_divider == 0) & (indent_level > 0.0)) {
|
||||
indent_divider = indent_level;
|
||||
}
|
||||
if (indent_divider > 0) {
|
||||
indent_level = indent_level / indent_divider;
|
||||
}
|
||||
|
||||
let entry = {
|
||||
text: link_title,
|
||||
link: link_url,
|
||||
//collapsed: true,
|
||||
//link_path,
|
||||
//level: indent_level,
|
||||
//collapsible: true,
|
||||
};
|
||||
//console.log("entry:");
|
||||
//console.log(entry);
|
||||
|
||||
//console.log("parents:");
|
||||
//console.log(parents);
|
||||
//console.log("current_parent - before pop");
|
||||
//console.log(current_parent);
|
||||
current_parent = parents.pop();
|
||||
//console.log("current_parent - after pop");
|
||||
//console.log(current_parent);
|
||||
|
||||
//console.log(`XX ST: indent: ${indent_level} lastlevel: ${lastlevel}`);
|
||||
if (indent_level == lastlevel) {
|
||||
//console.log(`XX EQ:`);
|
||||
//console.log(current_parent);
|
||||
const parentArray = getEntryArray(current_parent);
|
||||
parentArray.push(entry);
|
||||
//console.log("current_parent after pushing last entry");
|
||||
//console.log(current_parent);
|
||||
|
||||
//console.log("eq parents before pushing back current parent");
|
||||
//console.log(parents);
|
||||
parents.push(current_parent);
|
||||
//console.log("EQ parents after pushing current parent");
|
||||
//console.log(parents);
|
||||
|
||||
//console.log("XX EQ3");
|
||||
} else if (indent_level > lastlevel) {
|
||||
//console.log("XX NEST");
|
||||
//console.log(
|
||||
// ` DEBUG:NEST: lastlev: ${lastlevel}/indent lev: ${indent_level}`
|
||||
// );
|
||||
// This is a child of the last element added to current parent
|
||||
|
||||
//console.log(current_parent);
|
||||
//console.log("NEST: current_parent - after pop");
|
||||
//console.log("NEST: parents before");
|
||||
//console.log(parents);
|
||||
|
||||
const parentArray = getEntryArray(current_parent);
|
||||
|
||||
//console.log(
|
||||
// "parentArray - we want to add entry to last entry in this array."
|
||||
//);
|
||||
//console.log(parentArray);
|
||||
|
||||
//Get the last element
|
||||
//console.log(`how many elements in array ${parentArray.length}`);
|
||||
//
|
||||
const lastElement = parentArray.pop();
|
||||
lastElement.collapsed = true;
|
||||
//console.log(`NEST: last element in array:`);
|
||||
//console.log(lastElement);
|
||||
const lastElementArray = getEntryArray(lastElement);
|
||||
//console.log(`NEST: last element array:`);
|
||||
lastElementArray.push(entry);
|
||||
//console.log(`NEST: last element after pushing event:`);
|
||||
//console.log(lastElement);
|
||||
// Push the last element back on to the parentArray
|
||||
parentArray.push(lastElement);
|
||||
//push current parent onto the parents array
|
||||
parents.push(current_parent);
|
||||
// push the element we just edited back onto the array so it can be current parent.
|
||||
parents.push(lastElement);
|
||||
//console.log("NEST: parents after");
|
||||
//console.log(parents);
|
||||
} else if (indent_level < lastlevel) {
|
||||
// gone up a level
|
||||
//console.log(`XX UP`);
|
||||
while (indent_level < lastlevel--) {
|
||||
//console.log(`pop ${lastlevel}`);
|
||||
//Here we have no item. Group has finished (with a group)
|
||||
//So add the current parent (finished) to its parent.
|
||||
//console.log('DEBUG: Gone UP from level: '+ indent_level + ' TO: ' + lastlevel)
|
||||
|
||||
current_parent = parents.pop();
|
||||
}
|
||||
const parentArray = getEntryArray(current_parent);
|
||||
parentArray.push(entry);
|
||||
//console.log("current_parent after pushing last entry");
|
||||
//console.log(current_parent);
|
||||
|
||||
//console.log("eq parents before pushing back current parent");
|
||||
//console.log(parents);
|
||||
parents.push(current_parent);
|
||||
}
|
||||
|
||||
//console.log("AFTER ADDING Entry:");
|
||||
//console.log("entry:");
|
||||
//console.log(entry);
|
||||
//console.log("parents:");
|
||||
//console.log(parents);
|
||||
} catch (err) {
|
||||
console.log(err);
|
||||
console.log(` DEBUG SOME ACTUAL PROBLEMXX2: ${err}`);
|
||||
}
|
||||
|
||||
//last_item = entry;
|
||||
|
||||
lastlevel = indent_level; //reset
|
||||
//console.log(`END OF ONE LINE:${indent_level} lastlevel: ${lastlevel}`);
|
||||
//console.log("PARENTS");
|
||||
//console.log(JSON.stringify(parents));
|
||||
});
|
||||
|
||||
//all lines done
|
||||
//console.log("All lines done parents:");
|
||||
//console.log(JSON.stringify(parents));
|
||||
|
||||
//console.log("topLevelParent");
|
||||
//console.log(topLevelParent);
|
||||
return topLevelParent.items;
|
||||
}
|
||||
|
||||
module.exports = {
|
||||
sidebar: function (lang) {
|
||||
const summaryfile_path = path.resolve(__dirname, "..", lang, "SUMMARY.md");
|
||||
//console.log("DEBUG: summaryfile_path: " + summaryfile_path);
|
||||
let data = "";
|
||||
|
||||
try {
|
||||
// read contents of the file
|
||||
data = fs.readFileSync(summaryfile_path, "UTF-8");
|
||||
} catch (err) {
|
||||
console.log(`DEBUG: ${lang} - SIDEBAR DEFINITION NOT FOUND`);
|
||||
}
|
||||
|
||||
const module_sidebar = parseGitbookSidebarToVuepress(data, lang);
|
||||
//console.log(`DEBUG: Before`);
|
||||
//console.log(`DEBUG: ${JSON.stringify(module_sidebar)}`);
|
||||
//console.log(`DEBUG: After`);
|
||||
return module_sidebar;
|
||||
},
|
||||
};
|
||||
@@ -0,0 +1,19 @@
|
||||
<template>
|
||||
</template>
|
||||
|
||||
|
||||
<script>
|
||||
/** Redirects to the given 'to' url, which is relative to the current location. Originates from https://github.com/vuejs/vuepress/issues/239#issuecomment-632567115 */
|
||||
export default {
|
||||
name: 'Redirect',
|
||||
props: {
|
||||
to: {
|
||||
type: String,
|
||||
required: true
|
||||
}
|
||||
},
|
||||
beforeMount() {
|
||||
document.location.replace(this.to);
|
||||
}
|
||||
}
|
||||
</script>
|
||||
@@ -0,0 +1,58 @@
|
||||
// https://vitepress.dev/guide/custom-theme
|
||||
import { h } from "vue";
|
||||
|
||||
import DefaultTheme from "vitepress/theme";
|
||||
import "./style.css";
|
||||
|
||||
// To support medium-zoom - like setup()
|
||||
import { onMounted, watch, nextTick } from "vue";
|
||||
import { useRoute } from "vitepress";
|
||||
import mediumZoom from "medium-zoom";
|
||||
|
||||
// For https://www.npmjs.com/package/lite-youtube-embed
|
||||
import { inBrowser } from "vitepress";
|
||||
import "lite-youtube-embed/src/lite-yt-embed.css";
|
||||
if (inBrowser) {
|
||||
// @ts-ignore
|
||||
import("lite-youtube-embed");
|
||||
}
|
||||
|
||||
// Support redirect plugin
|
||||
import Redirect from "./components/Redirect.vue";
|
||||
|
||||
// Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
|
||||
import { Tab, Tabs } from "vue3-tabs-component";
|
||||
import "@red-asuka/vitepress-plugin-tabs/dist/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 }) {
|
||||
app.component("Redirect", Redirect); //Redirect plugin
|
||||
//Tabs: https://github.com/Red-Asuka/vitepress-plugin-tabs
|
||||
app.component("Tab", Tab);
|
||||
app.component("Tabs", Tabs);
|
||||
},
|
||||
|
||||
// to support medium zoom: https://github.com/vuejs/vitepress/issues/854
|
||||
setup() {
|
||||
const route = useRoute();
|
||||
const initZoom = () => {
|
||||
//mediumZoom("[data-zoomable]", { background: "var(--vp-c-bg)" });
|
||||
mediumZoom(".main img", { background: "var(--vp-c-bg)" });
|
||||
};
|
||||
onMounted(() => {
|
||||
initZoom();
|
||||
});
|
||||
watch(
|
||||
() => route.path,
|
||||
() => nextTick(() => initZoom())
|
||||
);
|
||||
},
|
||||
//end to support medium zoom
|
||||
};
|
||||
@@ -0,0 +1,162 @@
|
||||
/**
|
||||
* 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: 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;
|
||||
}
|
||||
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* Component: Medium Zoom: https://github.com/vuejs/vitepress/issues/854
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
.medium-zoom-overlay {
|
||||
z-index: 20;
|
||||
}
|
||||
|
||||
.medium-zoom-image {
|
||||
z-index: 21;
|
||||
}
|
||||
|
||||
|
||||
/**
|
||||
* Override styles as needed
|
||||
* -------------------------------------------------------------------------- */
|
||||
|
||||
.vp-doc img {
|
||||
display: inline; /* block by default set by vitepress */
|
||||
}
|
||||
Reference in New Issue
Block a user