Skip to content
This repository has been archived by the owner on Nov 14, 2024. It is now read-only.

Commit

Permalink
First stab at initial docs. Bad frontpage.
Browse files Browse the repository at this point in the history
  • Loading branch information
reynoldsalec committed Jan 25, 2024
1 parent 1b18d6a commit 3039e82
Show file tree
Hide file tree
Showing 60 changed files with 6,349 additions and 2,270 deletions.
8 changes: 3 additions & 5 deletions .eslintignore
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
.temp
.cache
temp
cache
dist
_site

.vuepress/dist
.vuepress/.cache
.vuepress/.temp
!.vitepress
2 changes: 1 addition & 1 deletion .eslintrc.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
}],
"require-jsdoc": ["error", {
"require": {
"FunctionDeclaration": true,
"FunctionDeclaration": false,
"MethodDefinition": false,
"ClassDeclaration": false,
"ArrowFunctionExpression": false,
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -40,3 +40,9 @@ coverage/
.cache
dist
_site

# vitepress thangs
.vitepress/.temp
.vitepress/cache
.vitepress/dist
.vitepress/config.*.timestamp-*-*.*
2 changes: 1 addition & 1 deletion .node-version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
16
18
146 changes: 146 additions & 0 deletions .vitepress/config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
import {createRequire} from 'module';

import {defineConfig} from '@lando/vitepress-theme-default-plus/config';

const require = createRequire(import.meta.url);

const {version} = require('../package.json');

export default defineConfig({
title: 'Lando',
description: 'Documentation.',
landoDocs: 3,
base: '/',
head: [
['meta', {name: 'viewport', content: 'width=device-width, initial-scale=1'}],
['link', {rel: 'icon', href: '/favicon.ico', size: 'any'}],
['link', {rel: 'icon', href: '/favicon.svg', type: 'image/svg+xml'}],
],
themeConfig: {
sidebar: {
'/': [
{
text: 'Getting Started',
collapsed: false,
items: [
{text: 'Introduction', link: '/getting-started/index'},
{text: 'How does it work?', link: '/getting-started/what-it-do'},
{text: 'Installation', link: '/getting-started/installation'},
{text: 'Starting your first app', link: '/getting-started/first-app'},
{text: 'Updating', link: '/getting-started/updating'},
{text: 'Uninstalling', link: '/getting-started/uninstalling'},
],
},
{
text: 'Lando 101',
collapsed: true,
items: [
{text: 'Overview', link: '/lando-101/index'},
{text: 'Lando Init', link: '/lando-101/lando-init'},
{text: 'Lando Start', link: '/lando-101/lando-start'},
{text: 'Lando Configure', link: '/lando-101/lando-config'},
{text: 'Lando Services', link: '/lando-101/lando-services'},
{text: 'Lando Proxy', link: '/lando-101/lando-proxy'},
{text: 'Lando Tooling', link: '/lando-101/lando-tooling'},
],
},
{
text: 'Guides',
collapsed: true,
items: [
{"link": "/guides/access-by-other-devices.html", "text": "Accessing Lando from Other Devices on Your Local Network"},
{"link": "/guides/db-export.html", "text": "SQL Export"},
{"link": "/guides/db-import.html", "text": "SQL Import"},
{"link": "/guides/external-access.html", "text": "Accessing Your Services Externally"},
{"link": "/guides/how-do-i-configure-a-lando-recipe.html", "text": "How do I configure a Lando Recipe?"},
{"link": "/guides/how-do-i-set-the-timezone-of-a-lando-service.html", "text": "How do I set the timezone of a Lando service?"},
{"link": "/guides/lando-info.html", "text": "Using $LANDO_INFO"},
{"link": "/guides/lando-phpstorm.html", "text": "Lando + PhpStorm + Xdebug"},
{"link": "/guides/lando-with-vscode.html", "text": "Using Lando with VSCode"},
{"link": "/guides/offline-dev.html", "text": "Developing offline"},
{"link": "/guides/overriding-a-service-version.html", "text": "Overriding a Service Version or Image"},
{"link": "/guides/updating-to-rc2.html", "text": "Updating to 3.0.0-rc.2+"},
{"link": "/guides/lando-corporate-network-tips.html", "text": "Lando in Corporate Network Environments"},
{"link": "/guides/accessibility.html", "text": "Accessibility and Lando"}
],
},
{
text: 'Troubleshooting',
collapsed: true,
items: [
{"link": "/help/logs.html", "text": "Accessing Logs"},
{"link": "/help/wkbox.html", "text": "Using Lando with Kalabox"},
{"link": "/help/updating.html", "text": "Updating"},
{"link": "/help/purging-containers.html", "text": "Purging Containers"},
{"link": "/help/dns-rebind.html", "text": "DNS Rebinding Protection"},
{"link": "/help/win-file-upload.html", "text": "Uploading Files in Windows"},
{"link": "/help/file-sync.html", "text": "File syncing issues"},
{"link": "/help/win-also-vb.html", "text": "Windows is also running VirtualBox"},
{"link": "/help/proxy", "text": "Running Lando behind a Proxy"},
{"link": "/help/switching-dbs.html", "text": "Switching Database Configuration"}
],
},
{
text: 'Contributing',
collapsed: true,
items: [
{"link": "/contrib/index.html", "text": "Getting Involved"},
{"link": "/contrib/coder.html", "text": "Coding"},
{"link": "/contrib/evangelist.html", "text": "Evangelizing"},
{"link": "/contrib/sponsoring.html", "text": "Sponsoring"}
],
},
],
},
},
});

function configSideBar() {
return [
{
text: 'Theme Configuration',
collapsed: false,
items: [
{text: 'Configuration', link: '/config/config'},
{text: 'Frontmatter', link: '/config/frontmatter'},
{text: 'useCollection()', link: '/composables/use-collection'},
{text: 'useTeam()', link: '/composables/use-team'},
],
},
{
text: 'Pages',
collapsed: false,
items: [
{text: 'Collections', link: '/pages/collections'},
{text: 'Teams', link: '/pages/teams'},
],
},
{
text: 'Global Components',
collapsed: false,
items: [
{text: 'Jobs', link: '/components/jobs'},
{text: 'MailChimp', link: '/components/mailchimp'},
{text: 'Sponsor', link: '/components/sponsors'},
{text: 'YouTube', link: '/components/youtube'},
],
},
{
text: 'Markdown Containers',
collapsed: false,
items: [
{text: 'Admonitions', link: '/markdown/admonitions'},
{text: 'Alignments', link: '/markdown/alignments'},
{text: 'Boxes', link: '/markdown/boxes'},
{text: 'Cards', link: '/markdown/cards'},
{text: 'Columns', link: '/markdown/columns'},
{text: 'Highlights', link: '/markdown/highlights'},
{text: 'Tabs', link: '/markdown/tabs'},
{text: 'Thumbnails', link: '/markdown/thumbnails'},
{text: 'Advanced', link: '/guides/advanced-markdown'},
],
},
{text: 'Blog', link: '/blog'},
{text: 'Guides', link: '/guides'},
];
}
3 changes: 3 additions & 0 deletions .vitepress/theme/index.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
import VPLTheme from '@lando/vitepress-theme-default-plus';

export default VPLTheme;
116 changes: 0 additions & 116 deletions .vuepress/config.js

This file was deleted.

83 changes: 0 additions & 83 deletions README.md

This file was deleted.

2 changes: 1 addition & 1 deletion contrib/coder.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ In fact, almost all of Lando's core functionality is provided via plugins. This

### Plugin Loading

Lando will search in the `plugins` directory for any path listed in `lando.config.pluginDirs` and automatically load in any plugins that it finds. By default, these directories are the Lando source directory and `~/.lando` but note that they are configurable via the Lando [global config](./../config/config.md). In order for Lando to successfully identify and automatically load your plugin, you need to have a directory named after your plugin, e.g. `my-plugin`, in one of the directories mentioned above and it needs to include an `index.js`.
Lando will search in the `plugins` directory for any path listed in `lando.config.pluginDirs` and automatically load in any plugins that it finds. By default, these directories are the Lando source directory and `~/.lando` but note that they are configurable via the Lando [global config](/config/global). In order for Lando to successfully identify and automatically load your plugin, you need to have a directory named after your plugin, e.g. `my-plugin`, in one of the directories mentioned above and it needs to include an `index.js`.

If there are multiple occurrences of the same-named plugin, Lando will use the last one it finds. This means that `lando` will prioritize user plugins over core plugins by default.

Expand Down
Loading

0 comments on commit 3039e82

Please sign in to comment.