338 lines
10 KiB
JavaScript
338 lines
10 KiB
JavaScript
|
import {default as isDevRelease} from '@lando/vitepress-theme-default-plus/is-dev-release';
|
||
|
|
import {default as getBaseUrl} from '@lando/vitepress-theme-default-plus/get-base-url';
|
||
|
|
|
||
|
|
import uniq from 'lodash-es/uniq.js';
|
||
|
|
|
||
|
|
export default function({
|
||
|
|
base,
|
||
|
|
landoPlugin,
|
||
|
|
themeConfig,
|
||
|
|
version,
|
||
|
|
baseUrl = getBaseUrl() ?? 'https://docs.lando.dev',
|
||
|
|
navrel = 'root',
|
||
|
|
} = {}) {
|
||
|
|
// if this is a lando plugin then reset the baseUrl
|
||
|
|
if (landoPlugin) baseUrl = getBaseUrl(landoPlugin);
|
||
|
|
|
||
|
|
// reset the base if its undefined
|
||
|
|
if (!base) base = landoPlugin ? `/plugins/${landoPlugin}/` : '/';
|
||
|
|
|
||
|
|
// reset baseUrl with dat base
|
||
|
|
baseUrl = `${baseUrl}${base}`;
|
||
|
|
|
||
|
|
// backwards compat with LANDO_MVB_VERSION
|
||
|
|
if (!process?.env?.VPL_MVB_VERSION && process?.env?.LANDO_MVB_VERSION) {
|
||
|
|
process.env.VPL_MVB_VERSION = process.env.LANDO_MVB_VERSION;
|
||
|
|
}
|
||
|
|
|
||
|
|
// allow version to imported from ENV which is nice for one-off dev builds
|
||
|
|
version = process?.env?.VPL_MVB_VERSION ? process.env.VPL_MVB_VERSION : `v${version}`;
|
||
|
|
|
||
|
|
// construct the rest
|
||
|
|
const text = ['core'].includes(landoPlugin) ? version : `${landoPlugin}@${version}`;
|
||
|
|
const repo = landoPlugin ? `https://github.com/lando/${landoPlugin}` : 'https://github.com/lando';
|
||
|
|
|
||
|
|
// if no sidebar ender and we have plugin/version then do it
|
||
|
|
if (!themeConfig.sidebarEnder && themeConfig.sidebarEnder !== false && landoPlugin && version) {
|
||
|
|
themeConfig.sidebarEnder = {
|
||
|
|
text,
|
||
|
|
collapsed: true,
|
||
|
|
items: [
|
||
|
|
{
|
||
|
|
text: 'Other Doc Versions',
|
||
|
|
items: [
|
||
|
|
{rel: 'mvb', text: 'stable', target: '_blank', link: '/stable/'},
|
||
|
|
{rel: 'mvb', text: 'edge', target: '_blank', link: '/edge/'},
|
||
|
|
{rel: 'mvb', text: '<strong>see all versions</strong>', link: '/'},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{text: 'Other Releases', link: `${repo}/releases`},
|
||
|
|
],
|
||
|
|
};
|
||
|
|
|
||
|
|
// add release notes
|
||
|
|
if (themeConfig.sidebarEnder && !isDevRelease(version)) {
|
||
|
|
themeConfig.sidebarEnder.items.splice(1, 0, {
|
||
|
|
text: 'Release Notes',
|
||
|
|
link: `${repo}/releases/tag/${version}`,
|
||
|
|
});
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
// combine internals
|
||
|
|
themeConfig.internalDomains = themeConfig.internalDomains ?? [];
|
||
|
|
|
||
|
|
// add the usual domains
|
||
|
|
themeConfig.internalDomains.push(
|
||
|
|
'http://localhost',
|
||
|
|
'https://localhost',
|
||
|
|
'http://docs.lando.dev',
|
||
|
|
'https://docs.lando.dev',
|
||
|
|
getBaseUrl(landoPlugin),
|
||
|
|
);
|
||
|
|
|
||
|
|
// if plugin then add netlify stuff
|
||
|
|
if (landoPlugin) {
|
||
|
|
themeConfig.internalDomains.push(`^https:\/\/lando-${landoPlugin}\.netlify\.app(\/.*)?$`);
|
||
|
|
themeConfig.internalDomains.push(`^https:\/\/[a-zA-Z0-9-]+--lando-${landoPlugin}\.netlify\.app(\/.*)?$`);
|
||
|
|
}
|
||
|
|
|
||
|
|
return {
|
||
|
|
base,
|
||
|
|
collections: {},
|
||
|
|
feed: {
|
||
|
|
patterns: ['*.md', '*/**/*.md'],
|
||
|
|
},
|
||
|
|
lang: 'en-US',
|
||
|
|
markdown: {},
|
||
|
|
robots: {
|
||
|
|
host: baseUrl,
|
||
|
|
sitemap: `${baseUrl}sitemap.xml`,
|
||
|
|
disallowAll: false,
|
||
|
|
allowAll: false,
|
||
|
|
policy: [],
|
||
|
|
policies: [{
|
||
|
|
userAgent: '*',
|
||
|
|
disallow: ['/v/'],
|
||
|
|
allow: '/',
|
||
|
|
}],
|
||
|
|
},
|
||
|
|
sitemap: {
|
||
|
|
hostname: getBaseUrl(landoPlugin) ?? 'https://docs.lando.dev/',
|
||
|
|
lastmodDateOnly: false,
|
||
|
|
transformItems: items => {
|
||
|
|
for (const item of items) {
|
||
|
|
item.url = `${base}${item.url}`;
|
||
|
|
item.priority = 0.5;
|
||
|
|
item.changefreq = 'daily';
|
||
|
|
}
|
||
|
|
return items;
|
||
|
|
},
|
||
|
|
},
|
||
|
|
themeConfig: {
|
||
|
|
alert: false,
|
||
|
|
autometa: {
|
||
|
|
canonicalUrl: getBaseUrl(landoPlugin) ?? 'https://docs.lando.dev/',
|
||
|
|
image: 'https://docs.lando.dev/images/icon.png',
|
||
|
|
x: '@devwithlando',
|
||
|
|
},
|
||
|
|
carbonAds: {
|
||
|
|
code: 'CE7DCKJU',
|
||
|
|
placement: 'landodev',
|
||
|
|
},
|
||
|
|
collections: {
|
||
|
|
post: {
|
||
|
|
frontmatter: {
|
||
|
|
collection: 'post',
|
||
|
|
contributors: false,
|
||
|
|
backLink: {
|
||
|
|
text: '<- Back to blog',
|
||
|
|
link: '/blog',
|
||
|
|
},
|
||
|
|
aside: false,
|
||
|
|
sidebar: false,
|
||
|
|
prev: false,
|
||
|
|
next: false,
|
||
|
|
editLink: false,
|
||
|
|
},
|
||
|
|
icon: '<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6"><path stroke-linecap="round" stroke-linejoin="round" d="M7.5 8.25h9m-9 3H12m-9.75 1.51c0 1.6 1.123 2.994 2.707 3.227 1.129.166 2.27.293 3.423.379.35.026.67.21.865.501L12 21l2.755-4.133a1.14 1.14 0 0 1 .865-.501 48.172 48.172 0 0 0 3.423-.379c1.584-.233 2.707-1.626 2.707-3.228V6.741c0-1.602-1.123-2.995-2.707-3.228A48.394 48.394 0 0 0 12 3c-2.392 0-4.744.175-7.043.513C3.373 3.746 2.25 5.14 2.25 6.741v6.018Z"/></svg>',
|
||
|
|
iconLink: '/blog',
|
||
|
|
patterns: ['blog/**/*.md'],
|
||
|
|
},
|
||
|
|
guide: {
|
||
|
|
frontmatter: {
|
||
|
|
collection: 'guide',
|
||
|
|
},
|
||
|
|
icon: '<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 24 24" stroke-width="1.5" stroke="currentColor" class="w-6 h-6"><path stroke-linecap="round" stroke-linejoin="round" d="M4.26 10.147a60.438 60.438 0 0 0-.491 6.347A48.62 48.62 0 0 1 12 20.904a48.62 48.62 0 0 1 8.232-4.41 60.46 60.46 0 0 0-.491-6.347m-15.482 0a50.636 50.636 0 0 0-2.658-.813A59.906 59.906 0 0 1 12 3.493a59.903 59.903 0 0 1 10.399 5.84c-.896.248-1.783.52-2.658.814m-15.482 0A50.717 50.717 0 0 1 12 13.489a50.702 50.702 0 0 1 7.74-3.342M6.75 15a.75.75 0 1 0 0-1.5.75.75 0 0 0 0 1.5Zm0 0v-3.675A55.378 55.378 0 0 1 12 8.443m-7.007 11.55A5.981 5.981 0 0 0 6.75 15.75v-1.5" /></svg>',
|
||
|
|
iconLink: '/guides',
|
||
|
|
patterns: ['guides/**/*.md'],
|
||
|
|
},
|
||
|
|
},
|
||
|
|
containers: {
|
||
|
|
'brand': {defaultTitle: 'BRAND'},
|
||
|
|
'box': {},
|
||
|
|
'box-blue': {},
|
||
|
|
'box-brand': {},
|
||
|
|
'box-green': {},
|
||
|
|
'box-red': {},
|
||
|
|
'box-yellow': {},
|
||
|
|
'caption': {},
|
||
|
|
'card': {},
|
||
|
|
'center': {},
|
||
|
|
'half': {},
|
||
|
|
'highlight': {},
|
||
|
|
'left': {},
|
||
|
|
'right': {},
|
||
|
|
'success': {defaultTitle: 'SUCCESS'},
|
||
|
|
'third': {},
|
||
|
|
'thumbnail': {},
|
||
|
|
},
|
||
|
|
contributors: {
|
||
|
|
merge: 'name',
|
||
|
|
debotify: true,
|
||
|
|
include: [
|
||
|
|
{
|
||
|
|
name: 'Mike Pirog',
|
||
|
|
email: 'mike@lando.dev',
|
||
|
|
title: 'Co-founder',
|
||
|
|
org: 'lando.dev',
|
||
|
|
orgLink: 'https://lando.dev',
|
||
|
|
links: [
|
||
|
|
{icon: 'github', link: 'https://github.com/pirog'},
|
||
|
|
{icon: 'twitter', link: 'https://twitter.com/pirogcommamike'},
|
||
|
|
],
|
||
|
|
sponsor: 'https://lando.dev/sponsor',
|
||
|
|
maintainer: true,
|
||
|
|
mergeOnly: true,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
name: 'John Ouelett',
|
||
|
|
email: 'john@thinktandem.io',
|
||
|
|
title: 'Robot From Future',
|
||
|
|
mergeOnly: true,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
avatar: 'https://avatars.githubusercontent.com/u/1153738',
|
||
|
|
name: 'Alec Reynolds',
|
||
|
|
email: 'alec+git@lando.dev',
|
||
|
|
title: 'Co-founder',
|
||
|
|
org: 'lando.dev',
|
||
|
|
orgLink: 'https://lando.dev',
|
||
|
|
desc: 'A chill dude',
|
||
|
|
links: [
|
||
|
|
{icon: 'github', link: 'https://github.com/reynoldsalec'},
|
||
|
|
{icon: 'twitter', link: 'https://twitter.com/reynoldsalec'},
|
||
|
|
],
|
||
|
|
sponsor: 'https://lando.dev/sponsor',
|
||
|
|
maintainer: true,
|
||
|
|
mergeOnly: true,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
editLink: {
|
||
|
|
pattern: `${repo}/edit/main/docs/:path`,
|
||
|
|
},
|
||
|
|
internalDomain: [],
|
||
|
|
internalDomains: uniq(themeConfig.internalDomains),
|
||
|
|
ga: {id: 'G-ZSK3T9FTQ9'},
|
||
|
|
hubspot: {id: '6478338'},
|
||
|
|
jobs: [
|
||
|
|
{
|
||
|
|
title: 'Lando Developer',
|
||
|
|
logo: 'https://docs.lando.dev/images/icon.svg',
|
||
|
|
link: 'https://docs.google.com/forms/d/e/1FAIpQLSc2vkesq59BblKo8ZX-R1hKTrHphh1kmsg4FgWV1WH5BKEjHQ/viewform',
|
||
|
|
company: 'Lando Alliance',
|
||
|
|
aux: 'DC, Remote',
|
||
|
|
},
|
||
|
|
],
|
||
|
|
lastUpdated: {
|
||
|
|
text: 'Updated',
|
||
|
|
formatOptions: {
|
||
|
|
dateStyle: 'timeago',
|
||
|
|
},
|
||
|
|
},
|
||
|
|
layouts: {},
|
||
|
|
logo: {src: '/images/icon.svg', width: 24, height: 24},
|
||
|
|
multiVersionBuild: {
|
||
|
|
base: '/v/',
|
||
|
|
build: 'stable',
|
||
|
|
cache: true,
|
||
|
|
match: 'v[0-9].*',
|
||
|
|
satisfies: '>=1.0.0',
|
||
|
|
ag: 'edge',
|
||
|
|
},
|
||
|
|
nav: [],
|
||
|
|
sidebar: {},
|
||
|
|
sidebarEnder: themeConfig.sidebarEnder ?? false,
|
||
|
|
search: {
|
||
|
|
provider: 'algolia',
|
||
|
|
options: {
|
||
|
|
appId: '9S3BH0SKWT',
|
||
|
|
apiKey: 'd3db589efd595b115848fc6a654d3263',
|
||
|
|
indexName: 'lando',
|
||
|
|
},
|
||
|
|
},
|
||
|
|
sharedNav: sharedNav(navrel),
|
||
|
|
socialLinks: [
|
||
|
|
{
|
||
|
|
icon: 'github',
|
||
|
|
link: repo,
|
||
|
|
},
|
||
|
|
{
|
||
|
|
icon: 'x',
|
||
|
|
link: 'https://x.com/@devwithlando',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
icon: 'youtube',
|
||
|
|
link: 'https://www.youtube.com/channel/UCl_QBNuGJNoo7yH-n18K7Kg',
|
||
|
|
},
|
||
|
|
{
|
||
|
|
icon: {
|
||
|
|
svg: '<svg class="shake" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path fill="red" d="M20.84 4.61a5.5 5.5 0 0 0-7.78 0L12 5.67l-1.06-1.06a5.5 5.5 0 0 0-7.78 7.78l1.06 1.06L12 21.23l7.78-7.78 1.06-1.06a5.5 5.5 0 0 0 0-7.78z"/></svg>',
|
||
|
|
},
|
||
|
|
link: 'https://lando.dev/sponsor',
|
||
|
|
},
|
||
|
|
],
|
||
|
|
sponsors: {
|
||
|
|
text: 'your logo?',
|
||
|
|
link: 'https://lando.dev/sponsor',
|
||
|
|
data: 'https://raw.githubusercontent.com/lando/lando/main/patriots.yaml',
|
||
|
|
all: 'https://raw.githubusercontent.com/lando/lando/main/sponsors.yaml',
|
||
|
|
},
|
||
|
|
tags: {},
|
||
|
|
tagLink: undefined,
|
||
|
|
team: [],
|
||
|
|
},
|
||
|
|
vite: {
|
||
|
|
css: {
|
||
|
|
preprocessorOptions: {
|
||
|
|
sass: {api: 'modern-compiler'},
|
||
|
|
scss: {api: 'modern-compiler'},
|
||
|
|
},
|
||
|
|
},
|
||
|
|
optimizeDeps: {exclude: []},
|
||
|
|
plugins: [],
|
||
|
|
resolve: {alias: []},
|
||
|
|
ssr: {noExternal: []},
|
||
|
|
},
|
||
|
|
};
|
||
|
|
};
|
||
|
|
|
||
|
|
function sharedNav(rel = navrel) {
|
||
|
|
return [
|
||
|
|
{
|
||
|
|
text: 'Core',
|
||
|
|
items: [
|
||
|
|
{
|
||
|
|
text: 'Landofile',
|
||
|
|
columns: 4,
|
||
|
|
items: [
|
||
|
|
{
|
||
|
|
text: 'Services',
|
||
|
|
link: `/landofile/services.html`,
|
||
|
|
rel,
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
text: 'Configuration',
|
||
|
|
columns: 3,
|
||
|
|
items: [],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
text: 'Plugins',
|
||
|
|
columns: 3,
|
||
|
|
items: [],
|
||
|
|
},
|
||
|
|
{
|
||
|
|
text: 'Services',
|
||
|
|
columns: 2,
|
||
|
|
items: [
|
||
|
|
{text: 'L-337', link: `/services/l337.html`, rel},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
],
|
||
|
|
},
|
||
|
|
];
|
||
|
|
};
|