14 | {{ page.title }} 15 |
16 | 17 |
20 | {{ page.summary }}
21 |
22 |
23 |
45 |
46 |
53 |
58 |
59 | Read More ->
60 |
61 |
62 | 13 |
14 | 15 |
20 |
27 |
28 | 29 | 30 |
31 |
33 |
34 |
40 |
--------------------------------------------------------------------------------
/docs/composables/use-tags.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about the VitePress Default Theme + useTags composable.
3 | ---
4 |
5 | # useTags
6 |
7 | You can `import` the `useTags()` composable from `@lando/vitepress-theme-default-plus` and use it to create a docs version index page or to show other taggy things.
8 |
9 | ```js
10 | const {
11 | // alias:ref pairs
12 | aliases,
13 | // alias:link pairs
14 | aliasLinks,
15 | // extended version information
16 | extended,
17 | // versions prepared for injection into `VPLVersionLink`
18 | links,
19 | // a list of all matched and satisfied versions
20 | versions,
21 | } = useTeam();
22 | ```
23 |
24 | Note that `aliasLinks` and `links` will _only_ be available if you've configured [Multiversion Build](./../config/config.md#multiversion-build).
25 |
26 | Here is how we generate our version [index page](/v/) at `/v/`.
27 |
28 | ```md
29 |
30 | ```
31 |
--------------------------------------------------------------------------------
/.eslintrc.json:
--------------------------------------------------------------------------------
1 | {
2 | "env": {
3 | "node": true,
4 | "mocha": true,
5 | "es6": true
6 | },
7 | "parser": "vue-eslint-parser",
8 | "parserOptions": {
9 | "parser": "babel-eslint",
10 | "allowImportExportEverywhere": true,
11 | "sourceType": "module",
12 | "ecmaVersion": 9
13 | },
14 | "extends": [
15 | "plugin:vue/recommended",
16 | "google"
17 | ],
18 | "rules": {
19 | "vue/multi-word-component-names": 0,
20 | "linebreak-style": 0,
21 | "arrow-parens": ["error",
22 | "as-needed"
23 | ],
24 | "max-len": ["error", {
25 | "code": 12000,
26 | "ignoreComments": true
27 | }],
28 | "require-jsdoc": ["error", {
29 | "require": {
30 | "FunctionDeclaration": false,
31 | "MethodDefinition": false,
32 | "ClassDeclaration": false,
33 | "ArrowFunctionExpression": false,
34 | "FunctionExpression": false
35 | }
36 | }]
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/docs/markdown/boxes.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about custom boxes markdown containers in VitePress Default Theme +
3 | ---
4 |
5 | # Box Containers
6 |
7 | Boxes are basically [admonitions](./admonitions.md) without the title and are about the _color_ instead of the _type_.
8 |
9 | ::: box
10 | This is a box.
11 | :::
12 |
13 | ::: box-blue
14 | This is a blue box.
15 | :::
16 |
17 | ::: box-brand
18 | This is a brand box.
19 | :::
20 |
21 | ::: box-green
22 | This is a green box.
23 | :::
24 |
25 | ::: box-red
26 | This is a red box.
27 | :::
28 |
29 | ::: box-yellow
30 | This is a yellow box.
31 | :::
32 |
33 | The above is achieved with the following markdown:
34 |
35 | ```md
36 | ::: box
37 | This is a box.
38 | :::
39 |
40 | ::: box-blue
41 | This is a blue box.
42 | :::
43 |
44 | ::: box-brand
45 | This is a brand box.
46 | :::
47 |
48 | ::: box-green
49 | This is a green box.
50 | :::
51 |
52 | ::: box-red
53 | This is a red box.
54 | :::
55 |
56 | ::: box-yellow
57 | This is a yellow box.
58 | :::
59 | ```
60 |
61 |
--------------------------------------------------------------------------------
/node/build-collections.js:
--------------------------------------------------------------------------------
1 | import fg from 'fast-glob';
2 | import Debug from 'debug';
3 |
4 | export default async function(siteConfig, {debug = Debug('@lando/build-collections')} = {}) { // eslint-disable-line
5 | // ensure siteConfig.collections is at least an empty object
6 | if (!siteConfig.collections || typeof siteConfig.collections !== 'object') siteConfig.collections = {};
7 |
8 | // before we start lets make sure we have a list of paths for each collection
9 | // we do it like this to minimize running fastglob a bunch of times
10 | for (const [collection, config] of Object.entries(siteConfig?.site?.themeConfig?.collections ?? {})) {
11 | if (!Array.isArray(siteConfig.collections[collection])) {
12 | siteConfig.collections[collection] = fg.globSync(config.patterns ?? [], {
13 | dot: true,
14 | cwd: siteConfig.srcDir,
15 | onlyFiles: true,
16 | });
17 | debug('built collection %o with page listing %o', collection, siteConfig.collections[collection]);
18 | }
19 | }
20 | };
21 |
--------------------------------------------------------------------------------
/docs/composables/use-team.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about the VitePress Default Theme + useTeam composable.
3 | ---
4 |
5 | # useTeam
6 |
7 | You can `import` the `useTeam()` composable from `@lando/vitepress-theme-default-plus` and use it to create a team or contributors page.
8 |
9 | ```js
10 | const members = useTeam();
11 | ```
12 |
13 | Here is how we generate our `/team` page:
14 |
15 | ```html
16 | ${title ? title : ''}
` : ''; 14 | 15 | // special handling for details 16 | if (name === 'details') return `${title}
\n`; 17 | // otherwise 18 | return `${titleMarkdown}\n`;
19 |
20 | // closing tag
21 | } else return name === 'details' ? `\n` : `
\n`;
22 | }},
23 | ];
24 | };
25 |
--------------------------------------------------------------------------------
/client/use-tags.js:
--------------------------------------------------------------------------------
1 | import {data as tags} from './tags.data.js';
2 |
3 | import {useData} from 'vitepress';
4 |
5 | export default function useTags() {
6 | // get version path data
7 | const {theme} = useData();
8 | // if no mvb then just return tags
9 | if (!theme.value.multiVersionBuild) return tags;
10 |
11 | // otherwise lets augment it with links and shit!
12 | const {base} = theme.value.multiVersionBuild;
13 |
14 | // generate links we can pass into VPLVersionLink
15 | const links = tags.versions
16 | .map(version => ({
17 | text: version,
18 | href: `/${base}/${version}/`.replace(/\/{2,}/g, '/'),
19 | prerelease: /^v?\d+\.\d+\.\d+-\S+$/.test(version),
20 | stable: tags?.aliases?.stable === version,
21 | edge: tags?.aliases?.edge === version,
22 | }));
23 |
24 | // also generate alias linkes
25 | const aliasLinks = {
26 | dev: `/${base}/dev/`.replace(/\/{2,}/g, '/'),
27 | edge: `/${base}/edge/`.replace(/\/{2,}/g, '/'),
28 | stable: `/${base}/stable/`.replace(/\/{2,}/g, '/'),
29 | };
30 |
31 | return {...tags, links, aliasLinks};
32 | }
33 |
--------------------------------------------------------------------------------
/utils/get-branch.js:
--------------------------------------------------------------------------------
1 | import {default as getStdOut} from './parse-stdout.js';
2 |
3 | export default function async(cwd = process.cwd()) {
4 | // lando build env directly
5 | if (process.env?.VPL_MVB_BRANCH) return process.env?.VPL_MVB_BRANCH;
6 | // lando build env directly
7 | else if (process.env?.LANDO_MVB_BRANCH) return process.env?.LANDO_MVB_BRANCH;
8 | // or from source
9 | else if (process.env?.VPL_MVB_SOURCE) return getStdOut('git rev-parse --abbrev-ref HEAD', {cwd: process.env?.VPL_MVB_SOURCE, trim: true});
10 | // or from source
11 | else if (process.env?.LANDO_MVB_SOURCE) return getStdOut('git rev-parse --abbrev-ref HEAD', {cwd: process.env?.LANDO_MVB_SOURCE, trim: true});
12 | // or if we are on netlify
13 | else if (process.env?.NETLIFY) return process.env.HEAD;
14 | // or GHA PR
15 | else if (process.env?.GITHUB_HEAD_REF) return process.env.GITHUB_HEAD_REF;
16 | // or GHA branch
17 | else if (process.env?.GITHUB_REF_NAME) return process.env.GITHUB_REF_NAME;
18 | // otherwise try to get it from git
19 | else return getStdOut('git rev-parse --abbrev-ref HEAD', {cwd, trim: true});
20 | };
21 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2025 Lando Alliance
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/docs/components/jobs.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about the VitePress Default Theme + global Jobs components.
3 | jobs:
4 | - title: 'Lando Developer'
5 | logo: 'https://docs.lando.dev/images/icon.svg'
6 | link: 'https://docs.google.com/forms/d/e/1FAIpQLSc2vkesq59BblKo8ZX-R1hKTrHphh1kmsg4FgWV1WH5BKEjHQ/viewform'
7 | company: 'Lando Alliance'
8 | aux: 'DC, Remote'
9 | ---
10 |
11 | # Jobs
12 |
13 | ### Usage
14 |
15 | To populate `
6 |
14 |
15 |
16 |
17 |
29 |
30 |
58 |
--------------------------------------------------------------------------------
/netlify.toml:
--------------------------------------------------------------------------------
1 | [build]
2 | base = "./"
3 | publish = "docs/.vitepress/dist/"
4 | command = "npx mvb docs"
5 |
6 | [context.deploy-preview]
7 | command = "npm run build"
8 | # https://github.com/munter/netlify-plugin-checklinks#readme
9 | [[context.deploy-preview.plugins]]
10 | package = "netlify-plugin-checklinks"
11 | [context.deploy-preview.plugins.inputs]
12 | todoPatterns = [ "load", "CHANGELOG.html", "x.com", "twitter.com", "/v/" ]
13 | skipPatterns = [ ".rss", ".gif", ".jpg", "--vitepress-theme-default-plus.netlify.app" ]
14 | checkExternal = true
15 |
16 | # Sets our asset optimization
17 | [build.processing.css]
18 | bundle = true
19 | minify = true
20 | [build.processing.js]
21 | bundle = true
22 | minify = true
23 | [build.processing.html]
24 | pretty_urls = false
25 | [build.processing.images]
26 | compress = true
27 |
28 | # Caches our images for 1 year
29 | [[headers]]
30 | for = "/images/*"
31 | [headers.values]
32 | Cache-Control = "public, max-age=31536000"
33 |
34 | # https://github.com/netlify/netlify-plugin-lighthouse#readme
35 | [[plugins]]
36 | package = "@netlify/plugin-lighthouse"
37 | [plugins.inputs.audits]
38 | output_path = "reports/lighthouse.html"
39 |
--------------------------------------------------------------------------------
/node/normalize-legacy-frontmatter.js:
--------------------------------------------------------------------------------
1 | import Debug from 'debug';
2 |
3 | export default async function(pageData, {
4 | siteConfig,
5 | debug = Debug('@lando/normalize-legacy-frontmatter'), // eslint-disable-line
6 | } = {}) {
7 | debug = debug.extend(`${pageData.relativePath}`);
8 | const {frontmatter} = pageData;
9 |
10 | // map and remove legacy vuepress2 theme blog setting
11 | if (!frontmatter.collection && frontmatter.blog === true) {
12 | pageData.frontmatter.collection = 'post';
13 | delete pageData.frontmatter.blog;
14 | debug('mapped frontmatter.blog to frontmatter.collection === post');
15 |
16 | // ditto for guide setting
17 | } else if (!frontmatter.collection && frontmatter.guide === true) {
18 | pageData.frontmatter.collection = 'guide';
19 | delete pageData.frontmatter.guide;
20 | debug('mapped frontmatter.guide to frontmatter.collection === guide');
21 | }
22 |
23 | // ditto for updated
24 | if (!frontmatter.date && frontmatter?.updated?.timestamp) {
25 | pageData.frontmatter.date = frontmatter.updated.timestamp;
26 | delete pageData.frontmatter.updated.timestamp;
27 | debug('mapped frontmatter.updated.timestamp to frontmatter.date');
28 | }
29 | };
30 |
--------------------------------------------------------------------------------
/vite/add-layout-components-plugin.js:
--------------------------------------------------------------------------------
1 | import Debug from 'debug';
2 | import {EOL} from 'node:os';
3 |
4 | const pivot = 'export default function(app) {';
5 |
6 | export default function(layouts = [], {debug = Debug('@lando/vite-plugin')}) { // eslint-disable-line
7 | return {
8 | name: 'inject-layouts',
9 | enforce: 'pre',
10 | transform: (code, id) => {
11 | const layoutfile = 'enhance-app-with-layouts.js';
12 | if (id.includes(layoutfile) && layouts.length > 0) {
13 | // get lines and pindex
14 | const lines = code.split(EOL);
15 | // get pivot line
16 | let pindex = lines.findIndex(line => line.startsWith(pivot));
17 | // loop through and add imports
18 | for (const layout of layouts.reverse()) lines.splice(pindex, 0, layout.import);
19 | // get pivot again
20 | pindex = lines.findIndex(line => line.startsWith(pivot)) + 1;
21 | // loop through again and add components
22 | for (const layout of layouts.reverse()) lines.splice(pindex, 0, layout.add);
23 | // debug
24 | debug('autogenerated layout import file %o with content %O', layoutfile, lines);
25 | return lines.join(EOL);
26 | }
27 | },
28 | };
29 | };
30 |
--------------------------------------------------------------------------------
/docs/guides/adding-remote-content.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Loading remote content
3 | description: Learn how to add remote markdown file
4 | editLink:
5 | url: https://github.com/lando/setup-lando/edit/main/docs/windows.md
6 |
7 | tags:
8 | - url-loader
9 | url-loader:
10 | source: https://raw.githubusercontent.com/lando/setup-lando/refs/heads/main/docs/windows.md
11 | content: append
12 | frontmatter: false
13 | ---
14 |
15 | ::: tip Below content is loaded via URL
16 |
17 | The content in this page is loaded from `https://raw.githubusercontent.com/lando/setup-lando/refs/heads/main/docs/windows.md`. Below is the actual frontmatter for this page that makes this whole thing possible.
18 |
19 | **Note that the content below is the Windows installer instructions for Lando and has nothing to do with this theme. We are just using it as an example of how `url-loader` works.**
20 |
21 | ```md
22 | title: Loading remote content
23 | description: Learn how to add remote markdown file
24 | editLink:
25 | url: https://github.com/lando/setup-lando/edit/main/docs/windows.md
26 |
27 | tags:
28 | - url-loader
29 | url-loader:
30 | source: https://raw.githubusercontent.com/lando/setup-lando/refs/heads/main/docs/windows.md
31 | content: append
32 | frontmatter: false
33 | ```
34 | :::
35 |
--------------------------------------------------------------------------------
/components/VPLCollectionPageTags.vue:
--------------------------------------------------------------------------------
1 |
2 |
12 |
13 |
14 |
36 |
37 |
53 |
--------------------------------------------------------------------------------
/node/add-contributors.js:
--------------------------------------------------------------------------------
1 | import Debug from 'debug';
2 |
3 | import {default as resolveGitPaths} from '../utils/resolve-git-paths.js';
4 | import {default as getContributors} from '../utils/get-contributors.js';
5 |
6 | export default async function(pageData, {
7 | debug = Debug('@lando/add-contributors'), // eslint-disable-line
8 | siteConfig,
9 | } = {}) {
10 | debug = debug.extend(`${pageData.relativePath}`);
11 | // get path
12 | const {frontmatter, relativePath} = pageData;
13 | // compute git things
14 | const gitDir = siteConfig?.userConfig?.gitRoot;
15 | const gitPaths = resolveGitPaths(relativePath, siteConfig.srcDir.replace(`${gitDir}/`, ''), frontmatter['git-include']);
16 |
17 | // get contributors
18 | const contributors = frontmatter.contributors || siteConfig?.site?.themeConfig?.contributors || false;
19 |
20 | // add contributors unless turned off
21 | if (contributors !== false) {
22 | try {
23 | pageData.contributors = await getContributors(gitDir, contributors, {debug, paths: gitPaths});
24 | debug('set contributors %o', pageData.contributors);
25 | } catch (error) {
26 | debug('could not get contributor information, considering this non-fatal but you should investigate and resolve');
27 | console.error(error);
28 | }
29 | }
30 | };
31 |
--------------------------------------------------------------------------------
/docs/components/mailchimp.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about the VitePress Default Theme + global MailChimp components.
3 | ---
4 |
5 | # MailChimp
6 |
7 | ### Usage
8 |
9 | You'll need to get the form action URL for the MailChimp audience you want the user to subscribe to. If you are not sure what that is all about then [check this out](https://mailchimp.com/help/determine-webpage-signup-location/).
10 |
11 | Otherwise you can embed the below directly into a `.vue` or `.md` file.
12 |
13 | ```html
14 |
3 |
7 |
9 |
16 |
17 |
18 |
70 |
--------------------------------------------------------------------------------
/docs/guides/guide-signup.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: Adding a guide signup
3 | description: Learn how to easily add a guide newsletter signup.
4 | guide: true
5 | mailchimp:
6 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
7 | title: Want similar content?
8 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
9 | button: Sign me up!
10 | tag:
11 | - tag 1
12 | - tag 2
13 | - secret tag
14 | - other tag
15 | - something else
16 | - we are really tagging a lot here
17 | ---
18 |
19 | # Adding a guide signup
20 |
21 | While you can leverage the global [MailChimp](./../components/mailchimp) component to add a newsletter signup to any page we've added a way to invoke it through `frontmatter` for convenience.
22 |
23 | **Note that this _only_ works for Guide content.**
24 |
25 | Here is how we do it for this page:
26 |
27 | ```md
28 | ---
29 | title: Adding a guide signup
30 | description: Learn how to easily add a guide newsletter signup.
31 | guide: true
32 | mailchimp:
33 | # action is required
34 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
35 | # everything else is optional
36 | title: Want similar content?
37 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
38 | button: Sign me up!
39 | ---
40 | ```
41 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | # Logs
2 | logs
3 | *.log
4 | npm-debug.log*
5 | yarn-debug.log*
6 | yarn-error.log*
7 | lerna-debug.log*
8 |
9 | # Apple
10 | .DS_Store
11 |
12 | # Diagnostic reports (https://nodejs.org/api/report.html)
13 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
14 |
15 | # Runtime data
16 | pids
17 | *.pid
18 | *.seed
19 | *.pid.lock
20 |
21 | # Directory for instrumented libs generated by jscoverage/JSCover
22 | lib-cov
23 |
24 | # Coverage directory used by tools like istanbul
25 | coverage
26 | *.lcov
27 |
28 | # nyc test coverage
29 | .nyc_output
30 |
31 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
32 | .grunt
33 |
34 | # Bower dependency directory (https://bower.io/)
35 | bower_components
36 |
37 | # node-waf configuration
38 | .lock-wscript
39 |
40 | # Dependency directories
41 | node_modules/
42 | jspm_packages/
43 |
44 | # TypeScript v1 declaration files
45 | typings/
46 |
47 | # TypeScript cache
48 | *.tsbuildinfo
49 |
50 | # Optional npm cache directory
51 | .npm
52 |
53 | # Optional eslint cache
54 | .eslintcache
55 |
56 | # Optional REPL history
57 | .node_repl_history
58 |
59 | # Output of 'npm pack'
60 | *.tgz
61 |
62 | # Yarn Integrity file
63 | .yarn-integrity
64 |
65 | # dotenv environment variables file
66 | .env
67 | .env.test
68 |
69 | # docs
70 | .temp
71 | .cache
72 | _site
73 | dist
74 | cache
75 | temp
76 | config.*.timestamp-*-*.*
77 | *.data.js.timestamp-*-*.*
78 |
79 | # YARN
80 | yarn.lock
81 |
--------------------------------------------------------------------------------
/docs/development.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn how to help develop and contribute to VitePress Default Theme Plus.
3 | ---
4 |
5 | # Development
6 |
7 | ## Requirements
8 |
9 | * [Node.js](https://nodejs.org/) version 18 or higher.
10 | * Terminal for accessing VitePress via its command line interface (CLI).
11 | * Text Editor with [Markdown](https://en.wikipedia.org/wiki/Markdown) syntax support.
12 | * [VSCode](https://code.visualstudio.com/) is recommended, along with the [official Vue extension](https://marketplace.visualstudio.com/items?itemName=Vue.volar).
13 |
14 | VitePress can be used on its own, or be installed into an existing project. In both cases, you can install it with:
15 |
16 | ## Up and Running
17 |
18 | ```sh
19 | # clone repo and install deps
20 | git clone https://github.com/lando/vitepress-theme-default-plus.git &&
21 | \ cd vitepress-theme-default-plus &&
22 | \ npm install
23 |
24 | # start dev server
25 | npm run dev
26 | ```
27 |
28 | ## Testing
29 |
30 | ```sh
31 | npm run test
32 | ```
33 |
34 | ## Building
35 |
36 | ```sh
37 | # build the static site
38 | npm run build
39 |
40 | # preview the static site
41 | npm run preview
42 | ```
43 |
44 | ## Releasing
45 |
46 | An actual release to `npm` can be done by [creating a release on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository). Pre-releases will deploy to `@edge` tag.
47 |
48 | This will also trigger our [prepare release](https://github.com/lando/prepare-release-action) and [auto-deploy](https://github.com/lando/auto-deploy-action) actions.
49 |
--------------------------------------------------------------------------------
/vite/patch-vp-use-sidebar-control.js:
--------------------------------------------------------------------------------
1 | import Debug from 'debug';
2 | import {EOL} from 'node:os';
3 |
4 | export default function({debug = Debug('@lando/vite-plugin')}) { // eslint-disable-line
5 | return {
6 | name: 'vp-use-sidebar-control',
7 | enforce: 'pre',
8 | transform: (code, id) => {
9 | const supportfile = 'dist/client/theme-default/composables/sidebar.js';
10 | if (id.includes(supportfile)) {
11 | // prepend our mvb normalizer
12 | code = `import { getItemNormalizedLink } from '@lando/vitepress-theme-default-plus';${EOL}${code}`;
13 | code = `import { normalizeItems } from '@lando/vitepress-theme-default-plus';${EOL}${code}`;
14 |
15 | // make sure we get "site" as well
16 | code = code.replace(
17 | 'const { page, hash } = useData()',
18 | 'const { site, page, hash } = useData()',
19 | );
20 |
21 | // and then use getItemNormalizedLink
22 | code = code.replace(
23 | 'isActive(page.value.relativePath, item.value.link)',
24 | 'isActive(page.value.relativePath, getItemNormalizedLink(item.value, site.value))',
25 | );
26 |
27 | // and also use normalizeItems
28 | code = code.replace(
29 | 'containsActiveLink(page.value.relativePath, item.value.items)',
30 | 'containsActiveLink(page.value.relativePath, normalizeItems(item.value.items, site.value))',
31 | );
32 |
33 | // log
34 | debug('patched %o to use getItemNormalizedLink', supportfile);
35 | return code;
36 | }
37 | },
38 | };
39 | };
40 |
--------------------------------------------------------------------------------
/components/VPLCollectionPage.vue:
--------------------------------------------------------------------------------
1 |
2 |
7 |
9 |
13 |
3 |
5 |
6 |
7 |
73 |
--------------------------------------------------------------------------------
/components/VPLCollectionIcon.vue:
--------------------------------------------------------------------------------
1 |
2 |
13 |
14 |
15 |
36 |
37 |
60 |
--------------------------------------------------------------------------------
/node/parse-collections.js:
--------------------------------------------------------------------------------
1 | import merge from 'lodash-es/merge.js';
2 |
3 | import Debug from 'debug';
4 |
5 | export default async function(pageData, {
6 | siteConfig,
7 | debug = Debug('@lando/parse-collections'), // eslint-disable-line
8 | } = {}) {
9 | debug = debug.extend(`${pageData.relativePath}`);
10 |
11 | // get stuff
12 | const {site} = siteConfig;
13 | const {themeConfig} = site;
14 | const {contributors, frontmatter, relativePath} = pageData;
15 |
16 | // loop through collections so we can assign default values
17 | await Promise.all(Object.entries(themeConfig?.collections ?? {}).map(async ([collection, config]) => {
18 | // get collection pages so we can do the match
19 | const pages = siteConfig?.collections[collection] ?? [];
20 | // if this is a match then do the collection stuff we need to do
21 | if (pages.includes(relativePath) || frontmatter.collection === collection) {
22 | // if no author is set then we should be able to set it with contrib info
23 | if ((frontmatter.authors === undefined
24 | || (Array.isArray(frontmatter.authors) && frontmatter.authors.length === 0))
25 | && Array.isArray(contributors)) {
26 | frontmatter.authors = contributors;
27 | debug('set authors %o using contributors information', frontmatter.authors.map(author => author.name));
28 | }
29 |
30 | // merge over defaults and save config and call it a day
31 | pageData.frontmatter = merge({}, config.frontmatter, frontmatter);
32 | pageData.collection = config;
33 |
34 | // log
35 | debug('rebased on collection %o defaults %O', collection, config.frontmatter);
36 | }
37 | }));
38 | };
39 |
--------------------------------------------------------------------------------
/components/VPLDogs.vue:
--------------------------------------------------------------------------------
1 |
2 | 
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 | aside-top
17 |
18 |
19 | aside-outline-before
20 |
21 |
22 | aside-outline-after
23 |
24 |
25 | aside-ads-before
26 |
27 |
28 | aside-ads-after
29 |
30 |
31 | aside-bottom
32 |
33 |
34 |
35 | CATVIBES
36 |
38 |
4 |
5 |
9 |
11 |
12 |
9 |
11 |
16 |
22 |
24 | 48 | 49 | And the markdown for the above: 50 | 51 | ```md 52 | ::: half 53 |  54 | ::: 55 | 56 | ::: half 57 |  58 | ::: 59 | 60 | ::::: center 61 | :::: third 62 | ::: box-red 63 | WAIT. 64 | ::: 65 | :::: 66 | :::: third 67 | ::: box-yellow 68 | FOR. 69 | ::: 70 | :::: 71 | :::: third 72 | ::: box-green 73 | IT. 74 | ::: 75 | :::: 76 | ::::: 77 | 78 | :::: center 79 | ::: third 80 |  81 | ::: 82 | ::: third 83 |  84 | ::: 85 | ::: third 86 |  87 | ::: 88 | :::: 89 | ``` 90 | -------------------------------------------------------------------------------- /utils/create-exec.js: -------------------------------------------------------------------------------- 1 | import {spawn} from 'node:child_process'; 2 | import {merge} from 'lodash-es'; 3 | import {bold, dim} from 'colorette'; 4 | 5 | import {default as mergePromise} from './merge-promise.js'; 6 | 7 | import Debug from 'debug'; 8 | 9 | export default function(defaults = {}) { 10 | return function(command, args = [], options = {}, stdout = '', stderr = '') { 11 | // @TODO: error handling? 12 | // merge our options over the defaults 13 | options = merge({debug: Debug('@lando/run-command'), ignoreReturnCode: false, env: process.env}, defaults, options); // eslint-disable-line 14 | const {debug} = options; 15 | 16 | // birth 17 | debug('running command %o %o from %o', command, args, options?.cwd ?? process.cwd()); 18 | const child = spawn(command, args, options); 19 | 20 | return mergePromise(child, async () => { 21 | return new Promise((resolve, reject) => { 22 | child.on('error', error => { 23 | debug('command %o error %o', command, error?.message); 24 | stderr += error?.message ?? error; 25 | }); 26 | 27 | child.stdout.on('data', data => { 28 | debug('%s %s', bold('stdout'), dim(data.toString().trim())); 29 | stdout += data; 30 | }); 31 | 32 | child.stderr.on('data', data => { 33 | debug('%s %s', bold('stderr'), dim(data.toString().trim())); 34 | stderr += data; 35 | }); 36 | 37 | child.on('close', code => { 38 | debug('command %o done with code %o', command, code); 39 | // if code is non-zero and we arent ignoring then reject here 40 | if (code !== 0 && !options.ignoreReturnCode) { 41 | const error = new Error(stderr); 42 | error.code = code; 43 | reject(error); 44 | } 45 | 46 | // otherwise return 47 | resolve({stdout, stderr, code}); 48 | }); 49 | }); 50 | }); 51 | }; 52 | }; 53 | -------------------------------------------------------------------------------- /docs/guides/making-a-guide-2.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Learn how to manually populate guide content using the VitePress Default Theme Plus. 3 | image: https://external-preview.redd.it/mj-2SFKKXAMK3tXrlo1smwLCSIantySqxSgfgMoJH2U.jpg?width=640&crop=smart&auto=webp&s=4f983b744fba16877e80218131a917b92904af26 4 | authors: 5 | - Mike Pirog 6 | - name: John Ouellet 7 | link: mailto:john@lando.dev 8 | pic: https://avatars.githubusercontent.com/u/5560907?v=4 9 | editLink: 10 | url: https://www.youtube.com/watch?v=dQw4w9WgXcQ 11 | text: Never gonna edit you up 12 | updated: 13 | timestamp: 1613073690000 14 | tags: 15 | - tag 1 16 | --- 17 | 18 | # Making a guide 2 19 | 20 | Guides are _how tos_ or _tutorials_ that fit somewhere in between technical documentation and blog posts. They generally 21 | seek to answer a single question such as "How do I create a guide using this theme?" and are heavy on code snippets. In this case there are actually two ways to create a guide: 22 | 23 | * Manually entering data 24 | * Autopopulating data from the `git log` 25 | 26 | ## Manually entering data 27 | 28 | To manually enter authorship, date and edit link information manually just add some combination of the below frontmatter to the top of your guide's markdown file. 29 | 30 | ::: tip Timestamp in ms 31 | If you use Unix time it must be in ms! 32 | ::: 33 | 34 | ```md 35 | --- 36 | authors: 37 | - Mike Pirog 38 | - name: John Ouellet 39 | link: mailto:john@lando.dev 40 | pic: https://avatars.githubusercontent.com/u/5560907?v=4 41 | editLink: 42 | url: https://www.youtube.com/watch?v=dQw4w9WgXcQ 43 | text: Never gonna edit you up 44 | date: 1613073690000 45 | --- 46 | ``` 47 | 48 | Note that `Mike Pirog` will be matched against existing contributors and its other data eg `pic|link|etc` will be merged in if its available. 49 | 50 | If you are interested in automatically setting the `authors`, `date` and edit link then check out [Making a Guide](./making-a-guide.html) 51 | -------------------------------------------------------------------------------- /components/VPLCollectionItemTags.vue: -------------------------------------------------------------------------------- 1 | 2 | 19 | 20 | 21 | 49 | 50 | 67 | -------------------------------------------------------------------------------- /node/generate-robots.js: -------------------------------------------------------------------------------- 1 | 2 | import {writeFileSync} from 'node:fs'; 3 | import {resolve} from 'node:path'; 4 | 5 | import merge from 'lodash-es/merge.js'; 6 | import robotstxt from 'generate-robotstxt'; 7 | 8 | import Debug from 'debug'; 9 | 10 | const defaults = { 11 | allowAll: false, 12 | disallowAll: false, 13 | policy: [], 14 | policies: [], 15 | file: 'robots.txt', 16 | }; 17 | 18 | const disallowAllPolicy = { 19 | userAgent: '*', 20 | disallow: '/', 21 | }; 22 | 23 | const allowAllPolicy = { 24 | userAgent: '*', 25 | disallow: '', 26 | }; 27 | 28 | export default async function({userConfig, outDir}, {debug = Debug('@lando/generate-robots')} = {}) { // eslint-disable-line 29 | // get robots config or defaults 30 | const robots = merge({}, defaults, userConfig.robots || userConfig?.themeConfig?.robots); 31 | 32 | // munge policies together 33 | robots.policy = [...robots.policy, ...robots.policies].filter(policy => policy); 34 | 35 | // if no polices and disallowAll=false then assume allowAll 36 | if (Array.isArray(robots.policy) && robots.policy.length === 0 && !robots.disallowAll) robots.allowAll = true; 37 | 38 | // robot vibes 39 | const {allowAll, disallowAll, host, sitemap} = robots; 40 | 41 | // if disallow all then thats all we need really 42 | if (disallowAll) robots.policy = [disallowAllPolicy]; 43 | // ditto for allow all 44 | else if (allowAll) robots.policy = [allowAllPolicy]; 45 | 46 | // build generate options 47 | const options = {policy: robots.policy}; 48 | // add host 49 | if (host) options.host = host; 50 | // add sitemap 51 | if (sitemap) options.sitemap = sitemap; 52 | debug('resolved robots.txt config from %o to %o', robots, options); 53 | 54 | // write file 55 | try { 56 | const dest = resolve(outDir, robots.file); 57 | const content = await robotstxt(options); 58 | writeFileSync(dest, content); 59 | debug('generated %o with content \n%O', dest, content); 60 | } catch (error) { 61 | throw error; 62 | } 63 | }; 64 | -------------------------------------------------------------------------------- /docs/components/sponsors.md: -------------------------------------------------------------------------------- 1 | --- 2 | description: Learn about the VitePress Default Theme + global Sponsors components. 3 | sponsors: 4 | text: your logo? 5 | link: https://lando.dev/sponsor 6 | data: https://raw.githubusercontent.com/lando/lando/main/patriots.yaml 7 | #data: https://raw.githubusercontent.com/lando/lando/main/package.json 8 | # data: 9 | # - name: stark 10 | # id: stark 11 | # url: https://en.wikipedia.org/wiki/Stark_Industries 12 | # logo: https://upload.wikimedia.org/wikipedia/commons/7/7d/Stark_Industries.png 13 | # type: half 14 | # - name: wayne 15 | # id: wayne 16 | # url: https://en.wikipedia.org/wiki/Wayne_Enterprises 17 | # logo: https://upload.wikimedia.org/wikipedia/commons/3/32/Wayne_Enterprises_%28DC_Comics_fictional_logo%29.png 18 | # type: half 19 | --- 20 | 21 | # Sponsors 22 | 23 | ### Usage 24 | 25 | To populate `
4 | {{ theme.lastUpdated?.text || theme.lastUpdatedText || 'Last updated' }} 5 | 6 |
7 |
5 |
6 |
7 |
8 |
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 |
20 |
21 |
22 |
23 |
24 |
25 |
26 |
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
37 |
3 |
9 | {{ item.text }}
10 |
16 |
17 |
18 |
55 |
56 |
88 |
--------------------------------------------------------------------------------
/components/VPLVersionLink.vue:
--------------------------------------------------------------------------------
1 |
2 |
13 | {{ props.version ?? props.text }}
14 |
6 |
10 | {{ props.title }}
11 |
12 |
36 |
37 |
38 |
39 |
57 |
58 |
109 |
--------------------------------------------------------------------------------
/docs/guides/adding-page-metadata.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn how to add social metatags to your content
3 | tags:
4 | - obscure
5 | head:
6 | - - meta
7 | - name: things:not-to-do
8 | content: give you up
9 | - - meta
10 | - name: things:not-to-do-2
11 | content: let you down
12 | - - meta
13 | - name: things:not-to-do-3
14 | content: run around
15 | - - meta
16 | - name: things:not-to-do-4
17 | content: desert you
18 | - - meta
19 | - name: things:not-to-do-5
20 | content: make you cry
21 | - - meta
22 | - name: things:not-to-do-6
23 | content: say goodbye
24 | - - meta
25 | - name: things:not-to-do-7
26 | content: tell a lie
27 | - - meta
28 | - name: things:not-to-do-8
29 | content: hurt you
30 | - - link
31 | - rel: canonical
32 | href: https://www.youtube.com/watch?v=dQw4w9WgXcQ
33 | ---
34 |
35 | # Adding page metadata
36 |
37 | Theme+ will automatically add commonly used metatags to your page based on the pages frontmatter, site information and theme configuration.
38 |
39 | If you care about this then we recommend you _at the very least_ set the `canonicalUrl` in the [theme config](../config/config.md#autometa) and set a `description` in the pages frontmatter.
40 |
41 | You can also override the `title` and `description` as well as add an optional `image` tags.
42 |
43 | ```md
44 | ---
45 | title: Making A Guide 2
46 | description: Learn how to manually populate guide content using the VuePress 2 Default Theme Plus.
47 | image: https://external-preview.redd.it/mj-2SFKKXAMK3tXrlo1smwLCSIantySqxSgfgMoJH2U.jpg?width=640&crop=smart&auto=webp&s=4f983b744fba16877e80218131a917b92904af26
48 | ---
49 | ```
50 |
51 | If you require MOAR POWAH you can add or edit _any_ additional metatags as you see fit using the `head` key inside of your frontmatter.
52 |
53 | ```md
54 | ---
55 | head:
56 | - - meta
57 | - name: things:not-to-do
58 | content: give you up
59 | - - meta
60 | - name: things:not-to-do-2
61 | content: let you down
62 | - - meta
63 | - name: things:not-to-do-3
64 | content: run around
65 | - - meta
66 | - name: things:not-to-do-4
67 | content: desert you
68 | - - meta
69 | - name: things:not-to-do-5
70 | content: make you cry
71 | - - meta
72 | - name: things:not-to-do-6
73 | content: say goodbye
74 | - - meta
75 | - name: things:not-to-do-7
76 | content: tell a lie
77 | - - meta
78 | - name: things:not-to-do-8
79 | content: hurt you
80 | - - link
81 | - rel: canonical
82 | href: https://www.youtube.com/watch?v=dQw4w9WgXcQ
83 | ---
84 | ```
85 |
--------------------------------------------------------------------------------
/client/use-collection.js:
--------------------------------------------------------------------------------
1 | import sortBy from 'lodash-es/sortBy.js';
2 | import uniq from 'lodash-es/uniq.js';
3 |
4 | import {computed, reactive} from 'vue';
5 | import {useData, useRoute} from 'vitepress';
6 | import {data as collections} from './collections.data.js';
7 |
8 | export default function useCollection(type = undefined) {
9 | const route = useRoute();
10 | const path = route.path;
11 | const {site, theme} = useData();
12 | const themeTags = theme.value?.tags ?? {};
13 |
14 | function findCurrentIndex() {
15 | const result = pages.findIndex(p => `${site.value?.base ?? ''}${p.url}`.replace(/\/+/g, '/') === route.path);
16 | if (result === -1) console.error(`content missing: ${route.path}`);
17 | return result;
18 | }
19 |
20 | // filter pages if needed
21 | const pages = type === undefined ? collections : collections.filter(page => page.type === type);
22 |
23 | // current
24 | const page = computed(() => pages[findCurrentIndex()]);
25 |
26 | // prev page or loop back to end unless the end is me
27 | const prevPage = computed(() => {
28 | const prev = pages[findCurrentIndex() - 1] ?? pages[pages.length - 1];
29 | return prev?.id !== page?.value?.id ? prev : undefined;
30 | });
31 | // next page or loop back to beginning unless the beginning is me
32 | const nextPage = computed(() => {
33 | const next = pages[findCurrentIndex() + 1] ?? pages[0];
34 | return next?.id !== page?.value?.id ? next : undefined;
35 | });
36 |
37 | // these are meant to replace the core next|prev nav links
38 | const prevnext = computed(() => ({
39 | prev: prevPage.value ? {text: prevPage.value.title, link: prevPage.value.url} : undefined,
40 | next: nextPage.value ? {text: nextPage.value.title, link: nextPage.value.url} : undefined,
41 | }));
42 |
43 | // get the tagz as well
44 | const sortedTags = sortBy(uniq(pages.map(page => page.tags).flat(Infinity)));
45 | const tags = reactive(Object.fromEntries(sortedTags.map(tag => ([tag, {
46 | selected: false,
47 | ...themeTags[tag] ?? {},
48 | }]))));
49 |
50 | // helper func to see if a set of tag filtered pages has items or not, useful for showing collection sections
51 | const hasItems = (items = [], tags = {}) => {
52 | const tagList = Object.entries(tags).filter(pair => pair[1].selected === true).map(pair => pair[0]);
53 | const filteredItems = items.filter(item => tagList.every(tag => item.tags.indexOf(tag) !== -1));
54 | return filteredItems.length > 0;
55 | };
56 |
57 | return {
58 | hasItems,
59 | pages,
60 | page,
61 | nextPage,
62 | prevnext,
63 | prevPage,
64 | path,
65 | tags,
66 | };
67 | }
68 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: VitePress Default Theme Plus extends the VitePress default theme with some extra power and features.
3 | layout: home
4 | hero:
5 | name: VitePress Theme +
6 | text: The Default Theme w/ MoAr PoWaH.
7 | tagline: The default VitePress theme extended with things helpful to BIG open source projects
8 | image:
9 | src: /images/vitepress-lando-logo.webp
10 | alt: VitePress
11 | actions:
12 | - theme: brand
13 | text: Get Started
14 | link: /overview
15 | - theme: alt
16 | text: View on GitHub
17 | link: https://github.com/lando/vitepress-theme-default-plus
18 | features:
19 | - icon: 🗃️
20 | title: Collections
21 | details: Organize and tag docs into categories like posts or guides each with default frontmatter.
22 | - icon: 🧾
23 | title: Navbar+
24 | details: Configurable dropdown column size, expiring badges and notifications.
25 | - icon: ''
26 | title: Feeds
27 | details: Generate one or many RSS feeds using glob patterns.
28 | - icon: 🧩
29 | title: Components
30 | details: Additonal markdown containers, YouTube, MailChimp and other components.
31 | - icon: 🦄
32 | title: Contributors
33 | details: Automatically populate contributor metadata from git.
34 | - icon: 🔨
35 | title: MVB
36 | details: Build multiple versions of your docs using our `mvb` command
37 | - icon: 🤖
38 | title: Autometa
39 | details: Automatically add metadata for X, Facebook, canonical links, etc.
40 | - icon: 🥳
41 | title: And More!
42 | details: Read on to learn what else VitePress Theme + has to offer...
43 | ---
44 |
45 |
48 |
49 |
50 |
52 |
53 |
71 |
--------------------------------------------------------------------------------
/docs/public/lando/logo.svg:
--------------------------------------------------------------------------------
1 |
--------------------------------------------------------------------------------
/components/VPLCollectionHeader.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
34 |
35 |
36 |
56 |
57 |
97 |
--------------------------------------------------------------------------------
/components/VPLMenuGroup.vue:
--------------------------------------------------------------------------------
1 |
2 |
4 |
11 |
15 |
33 |
16 | By
17 |
23 | {{ author.name }}{{ getSeparator(index, authors.length) }}
24 |
25 |
26 |
3 |
20 |
21 |
22 |
56 |
57 |
117 |
--------------------------------------------------------------------------------
/docs/blog/making-a-blog-post-2.md:
--------------------------------------------------------------------------------
1 | ---
2 | byline: Blog posts are free form articles that may or may not be techincal in nature. They differ slightly from guides primarily in their presentation and authorship.
3 | blog: true
4 | date: January 11, 2024
5 | location: The Interwebs
6 | contributors: false
7 | mailchimp:
8 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
9 | title: Want more Pirog themed content?
10 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
11 | button: Sign me up!
12 | tags:
13 | - this is a test tag
14 | ---
15 |
16 | # Making a post 2
17 |
18 | Specifically, they make use of a `byline` and can only have a single, manually entered, author. They can be thought of more like "traditional" news media articles. Like guides you can create them in two ways:
19 |
20 | :::tip Mixed signals?
21 | Yes, we know that this actually should be a `Guide` instead of a blog post! However, in this weird case we think its better to use `BlogPost` so we can best illustrate the capabilities.
22 | :::
23 |
24 | ## Basics
25 |
26 | ```md
27 | ---
28 | title: "Making A Blog Post: It's sort of like a guide but it's sort of not like a guide"
29 | byline: Blog posts are free form articles that may or may not be techincal in nature. They differ slightly from guides primarily in their presentation and authorship.
30 | blog: true
31 | ---
32 | ```
33 |
34 | ::: warning You must set the title!
35 | Note that because of how the underlying components are layered and called you must set the title in the frontmatter. This will populate the `h1` on the page. You can and should then omit the `h1` in the markdown content itself.
36 | :::
37 |
38 | You can check out the full markdown file that generated this page [here](https://github.com/lando/vitepress-theme-default-plus/blob/main/docs/guides/making-a-guide-2.md). If you are interested in manually setting the `authors`, `date` and edit link then check out [Making a Guide 2](../guides/making-a-guide-2.html)
39 |
40 | ## Authorship
41 |
42 | You must at least specify a name!
43 |
44 | ```md
45 | ---
46 | author:
47 | name: Mike Pirog
48 | link: mailto:mike@lando.dev
49 | pic: https://gravatar.com/avatar/dc1322b3ddd0ef682862d7f281c821bb
50 | location: Washington, DC
51 | ---
52 | ```
53 |
54 | ## Signup
55 |
56 | ```md
57 | ---
58 | mailchimp:
59 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
60 | title: Want more Pirog themed content?
61 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
62 | button: Sign me up!
63 | ---
64 | ```
65 |
--------------------------------------------------------------------------------
/docs/blog/making-a-blog-post.md:
--------------------------------------------------------------------------------
1 | ---
2 | byline: Blog posts are free form articles that may or may not be techincal in nature. They differ slightly from guides primarily in their presentation and authorship.
3 | blog: true
4 | date: January 11, 2024
5 | location: Washington, DC
6 | mailchimp:
7 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
8 | title: Want more Pirog themed content?
9 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
10 | button: Sign me up!
11 | tags:
12 | - this is a test tag
13 | ---
14 |
15 | # Making a blog post and other stuff like that
16 |
17 | Specifically, they make use of a `byline` and can only have a single, manually entered, author. They can be thought of more like "traditional" news media articles. Like guides you can create them in two ways:
18 |
19 | :::tip Mixed signals?
20 | Yes, we know that this actually should be a `Guide` instead of a blog post! However, in this weird case we think its better to use `BlogPost` so we can best illustrate the capabilities.
21 | :::
22 |
23 | ## Basics
24 |
25 | ```md
26 | ---
27 | title: "Making A Blog Post: It's sort of like a guide but it's sort of not like a guide"
28 | byline: Blog posts are free form articles that may or may not be techincal in nature. They differ slightly from guides primarily in their presentation and authorship.
29 | blog: true
30 | ---
31 | ```
32 |
33 | ::: warning You must set the title!
34 | Note that because of how the underlying components are layered and called you must set the title in the frontmatter. This will populate the `h1` on the page. You can and should then omit the `h1` in the markdown content itself.
35 | :::
36 |
37 | You can check out the full markdown file that generated this page [here](https://github.com/lando/vitepress-theme-default-plus/blob/main/docs/guides/making-a-guide.md). If you are interested in manually setting the `authors`, `date` and edit link then check out [Making a Guide 2](../guides/making-a-guide-2.html)
38 |
39 | ## Authorship
40 |
41 | You must at least specify a name!
42 |
43 | ```md
44 | ---
45 | author:
46 | name: Mike Pirog
47 | link: mailto:mike@lando.dev
48 | pic: https://gravatar.com/avatar/dc1322b3ddd0ef682862d7f281c821bb
49 | location: Washington, DC
50 | ---
51 | ```
52 |
53 | ## Signup
54 |
55 | ```md
56 | ---
57 | mailchimp:
58 | action: https://dev.us12.list-manage.com/subscribe/post?u=59874b4d6910fa65e724a4648&id=613837077f
59 | title: Want more Pirog themed content?
60 | byline: Signup and we will send you a weekly blog digest of similar content to keep you satiated.
61 | button: Sign me up!
62 | ---
63 | ```
64 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # VitePress Default Theme +
2 |
3 | This extends the [default VitePress theme](https://vitepress.dev/) with some extra power and features such as:
4 |
5 | 7 | {{ props.text }} 8 |
9 | 10 |
11 |
12 |
19 |
6 |
7 | 
8 |
9 |
10 |
11 | Or just go to the [docs](https://vitepress-theme-default-plus.lando.dev) for the docs to learn more.
12 |
13 | ## Docs
14 |
15 | * [Overview](https://vitepress-theme-default-plus.lando.dev/overview)
16 | * [Installation](https://vitepress-theme-default-plus.lando.dev/install.html)
17 | * [Usage](https://vitepress-theme-default-plus.lando.dev/usage.html)
18 | * [Configuration](https://vitepress-theme-default-plus.lando.dev/config/config.html)
19 | * [Guides](https://vitepress-theme-default-plus.lando.dev/guides.html)
20 | * [Examples](https://github.com/lando/vitepress-theme-default-plus)
21 | * [Development](https://vitepress-theme-default-plus.lando.dev/development.html)
22 |
23 | ## Issues, Questions and Support
24 |
25 | If you have a question or would like some community support we recommend you [join us on Slack](https://launchpass.com/devwithlando). Note that this is the Slack community for [Lando](https://lando.dev) but we are more than happy to help with this module as well!
26 |
27 | If you'd like to report a bug or submit a feature request then please [use the issue queue](https://github.com/lando/vitepress-theme-default-plus/issues/new/choose) in this repo.
28 |
29 | ## Changelog
30 |
31 | We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/vitepress-theme-default-plus/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/vitepress-theme-default-plus/releases).
32 |
33 | ## Releasing
34 |
35 | To deploy and publish a new version of the package to the `npm` registry you need only [create a release on GitHub](https://docs.github.com/en/repositories/releasing-projects-on-github/managing-releases-in-a-repository) with a [semver](https://semver.org) tag.
36 |
37 | Note that prereleases will get pushed to the `edge` tag on the `npm` registry.
38 |
39 | ## Maintainers
40 |
41 | * [@pirog](https://github.com/pirog)
42 | * [@reynoldsalec](https://github.com/reynoldsalec)
43 |
44 | ## Contributors
45 |
46 |
47 |
30 |
33 |
34 |
35 |
36 |
3 |
44 |
45 |
46 |
79 |
80 |
120 |
--------------------------------------------------------------------------------
/node/generate-feeds.js:
--------------------------------------------------------------------------------
1 |
2 | import {writeFileSync} from 'node:fs';
3 | import {join} from 'node:path';
4 |
5 | import {default as createContentLoader} from '../utils/create-content-loader.js';
6 |
7 | import Debug from 'debug';
8 | import {Feed} from 'feed';
9 |
10 | const normalizeUrl = url => url.replace(/([^:]\/)\/+/g, '$1');
11 |
12 | // helper to normalize things
13 | const normalizeConfig = (config = {}, feed = 'feed') => {
14 | // pluralize
15 | if (!config.patterns && config.pattern) {
16 | config.patterns = config.pattern;
17 | delete config.pattern;
18 | }
19 |
20 | // arrayize
21 | if (typeof config.patterns === 'string') config.patterns = [config.patterns];
22 |
23 | // set filename if it isnt set
24 | if (!config.file) config.file = `/${feed}.rss`;
25 |
26 | // add the feed name just for the hell of it?
27 | config.name = feed;
28 |
29 | return config;
30 | };
31 |
32 | const sort = items => items.sort((a, b) => a.timestamp < b.timestamp ? 1 : -1);
33 |
34 | export default async function(siteConfig, {debug = Debug('@lando/generate-feeds')} = {}) { // eslint-disable-line
35 | const {userConfig, site, outDir} = siteConfig;
36 |
37 | // get config from priority sources
38 | const config = userConfig.feeds
39 | || userConfig?.themeConfig?.feeds
40 | || userConfig.feed
41 | || userConfig?.themeConfig?.feed;
42 |
43 | // if feeds is false or undefined then just end it all right here
44 | if (!config) return;
45 |
46 | // if feeds has only one top level feed then bump it down
47 | const feeds = (config.patterns || config.pattern) ? {feed: config} : config;
48 |
49 | // loop through and generate feedzzz
50 | await Promise.all(Object.entries(feeds).map(async ([name, config]) => {
51 | config = normalizeConfig(config, name);
52 | const {href} = new URL(site.base ?? '/', config.baseUrl ?? userConfig.baseUrl);
53 |
54 | const feed = new Feed({
55 | title: config.title ?? site.title ?? '',
56 | description: config.description ?? config.description ?? '',
57 | id: normalizeUrl(config.id ?? href),
58 | link: normalizeUrl(config.link ?? href),
59 | language: config.language ?? 'en',
60 | image: config.image ?? '',
61 | favicon: normalizeUrl(config.favicon ?? `${href}/favicon.ico`),
62 | copyright: config.copyright ?? '',
63 | });
64 |
65 | // get items
66 | const items = await createContentLoader(config.patterns, {excerpt: true, render: true, siteConfig}, {debug}).load();
67 |
68 | // and loop theough them to add
69 | for (const item of sort(items)) {
70 | const {authors, timestamp, excerpt, html, summary, title, url} = item;
71 |
72 | // initial payload
73 | const data = {
74 | title,
75 | id: normalizeUrl(`${href}${url}`),
76 | link: normalizeUrl(`${href}${url}`),
77 | description: excerpt !== '' ? excerpt : summary,
78 | content: html,
79 | date: new Date(timestamp),
80 | };
81 |
82 | // add authors if we have them
83 | if (authors && Array.isArray(authors)) data.authors = authors.map(({name, link}) => ({name, link}));
84 |
85 | // SHE ALWAYS NEEDS TO FEED
86 | feed.addItem(data);
87 | }
88 |
89 | // write feed
90 | const dest = join(outDir, config.file);
91 | writeFileSync(dest, feed.rss2());
92 | debug('generated rss feed %o', dest);
93 | }));
94 | }
95 |
--------------------------------------------------------------------------------
/components/VPLNavBarMenuGroup.vue:
--------------------------------------------------------------------------------
1 |
2 |
14 |
21 |
27 | {{ author.name }}{{ getSeparator(index, authors.length) }}
28 |
29 | from
30 |
34 | {{ hlocation }}
35 |
36 | on
37 |
43 |
3 |
7 |
13 |
14 |
15 |
109 |
110 |
124 |
--------------------------------------------------------------------------------
/components/VPLCollectionItems.vue:
--------------------------------------------------------------------------------
1 |
2 |
3 |
28 | load more
29 |
30 |
31 |
32 |
33 |
97 |
98 |
138 |
--------------------------------------------------------------------------------
/docs/pages/collections.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Learn about the VitePress Default Theme + collections components.
3 | ---
4 |
5 | # Collections Pages
6 |
7 | You can `import` some helpful `components` from `@lando/vitepress-theme-default-plus` and compose collections pages.
8 |
9 | This is especially useful when used in tandem with [useCollection()](../composables/use-collection.md).
10 |
11 | Here is what we do to create `/guide` for this site.
12 |
13 | ```html
14 |
15 | ```
16 |
17 | You can also check out [/all](/all) and its [code](https://github.com/lando/vitepress-theme-default-plus/blob/main/docs/all.md) for an example that combines all available collections components.
18 |
19 | ## \
7 |
20 |
12 |
18 |
19 |
6 |
34 |
35 |
36 |
70 |
71 |
139 |
--------------------------------------------------------------------------------
/docs/guides/tagging-shit.md:
--------------------------------------------------------------------------------
1 | ---
2 | description: Some basic information around tagging stuff
3 | tags:
4 | - obscure
5 | - this is a test tag
6 | - tag 2
7 | - secret tag
8 | ---
9 |
10 | # Tagging shit
11 |
12 | There are a few different tagging related things in these docs so this guide tries to [tie the room together](https://www.youtube.com/watch?v=_vGK008c_rA) on it.
13 |
14 | ## What can I tag?
15 |
16 | Any [collections](../config/config.md#collections) based content can be tagged via [frontmatter](../config/frontmatter.md#tags) as below:
17 |
18 | ```md
19 | ---
20 | description: Some basic information around tagging stuff
21 | tags:
22 | - obscure
23 | - this is a test tag
24 | - tag 2
25 | ---
26 | ```
27 |
28 | ## Whats tags are available?
29 |
30 | By default you can "free tag" which means there is not a centralized or finite set of acceptable tags. You can, however, [customize the appearance](../config/config.md#tags) of the tags. For example you can change the styling, add an icon or change the `tagLink` for a specific tag.
31 |
32 | Look at the TAGS section in the aside for this page. The customization of those tags is provided by the below theme config:
33 |
34 | ```js
35 | tags: {
36 | 'obscure': {
37 | color: 'var(--vp-c-purple-1)',
38 | styles: {
39 | color: 'var(--vp-c-white)',
40 | },
41 | icon: '',
42 | },
43 | 'secret tag': {
44 | color: '#C0FFEE',
45 | icon: '',
46 | link: 'https://www.youtube.com/watch?v=HU2ftCitvyQ',
47 | styles: {
48 | color: '#BA11AD',
49 | },
50 | },
51 | 'tag 2': {
52 | icon: '',
53 | },
54 | },
55 | ```
56 |
57 | ## Where do the tags link to?
58 |
59 | You can provide a URL default pattern with [tagLink](../config/config.md#tag-link). This can then be overriden on a per-tag basis using `tags[tag].link`.
60 |
61 | In the [above section](#whats-tags-are-available) the `secret tag` has been customized to link externally to this [helpful rock climbing tutorial](https://www.youtube.com/watch?v=HU2ftCitvyQ).
62 |
63 | ## Can I add tags to a page?
64 |
65 | You can add a [filter](../pages/collections.md#vplcollectionpagetags) to a [Collections Page](../pages/collections.md). You can also get a list of a given pages Tags with the below:
66 |
67 | ```html
68 |
7 |
28 |
32 |
33 |