VitePress Default Theme +

This extends the default VitePress theme with some extra power and features such as:

Or just go to the docs for the docs to learn more.

Docs

• Overview
• Installation
• Usage
• Configuration
• Guides
• Examples
• Development

Issues, Questions and Support

If you have a question or would like some community support we recommend you join us on Slack. Note that this is the Slack community for Lando but we are more than happy to help with this module as well!

If you'd like to report a bug or submit a feature request then please use the issue queue in this repo.

Changelog

We try to log all changes big and small in both THE CHANGELOG and the release notes.

Releasing

To deploy and publish a new version of the package to the npm registry you need only create a release on GitHub with a semver tag.

Note that prereleases will get pushed to the edge tag on the npm registry.

Maintainers

• @pirog
• @reynoldsalec

Contributors

Made with contributors-img.

Other Resources

• Important advice

{{ UNRELEASED_VERSION }} - [{{ UNRELEASED_DATE }}]({{ UNRELEASED_LINK }})

v1.1.1 - February 14, 2025

• Fixed bug causing mvb and vitepress build to fail when landoPlugin is set and VPL_BASE_URL or NETLIFY are not

v1.1.0 - February 14, 2025

New Features

• Added version alias information to config
• Added RegEx support for internalDomains matching
• Added get-base-url helper util
• Added is-faux-internal helper util
• Added caching to mvb multiversion build
• Added better dev branch detection to mvb
• Added frontmatter.url-loader to allow .md files to pull content from remote markdown sources
• Added new multiversion-vitepress-build command
• Added useTags composable to get docs version information from git
• Added VPLVersionLink component
• Changed VPLVersionLink to not normalize links
• Improved get-tags and mvb to better handle scenarios with no matchings versions or tags
• Improved robustness of mvb build environment generation
• Improved is-dev-release to handle dev releases that are in front of a prerelease tag
• Improved dev release resolution
• Improved mvb and root link normalization
• Improved VPLVersionLink to only need version input
• Switched these docs to multiversion-vitepress-build
• Updated to vitepress@1.5.0
• Updated scss and sass compilation to modern-compiler

Bug Fixes

• Fixed frontmatter.editLink to fallback to theme and default text if not passed in
• Fixed incorrect lodash-es/uniq.js import in landov3 config set
• Fixed bug causing build error when metadata is added to a page with no git history
• Fixed bug caused by icon being a variable instead of a string in VPLTeamMembersItem
• Fixed bug caused by VPLTeamMembers.members typing as Object instead of Array
• Fixed bug causing robots.txt policies to not be applied when using policies instead of policy
• Fixed watch bug on VPLCollectionItems preventing tag toggling from working correctly
• Fixed bug in VPLLink causing some links to to not normalize correctly
• Fixed bug causing VPLDocFooter bleed over with some frontmatter combinations of prev and next
• Fixed semver import causing all kinds of chaos when importing this theme as a package
• Fixed bug causing alias.dev to always report highest built tag instead of actual dev version
• Fixed useTags() to return correct links for sites with non-root base considerations take 2
• Fixed prev-next calculation when using sites with non / bases #55
• Fixed bug with <VPLLink> not dynamically updating and showing strange behavior for prev|next links
• Fixed bug causing active to not be correctly set on VPLNavBarMenuGroup
• Fixed bug in normalize-mvb causing multiVersionBuild.build to sometimes not be set correctly
• Fixed lando configset bug causing sidebarEnder to not merge correctly
• Fixed bug preventing user specified buildEnd and transformPageData from running after theme's
• Fixed bug preventing mvb from correctly setting the mvbase
• Fixed duplicate // in generated rss feed
• Fixed bug causing robots.txt build to throw an error when policies is undefined
• Fixed bug causing netlify specific mvb to not get current tags
• Fixed git tag dev alias detection to incorrectly report fatal: Not a valid object name undefined on first attempt

v1.1.0-beta.24 - November 23, 2024

• Improved mvb tag fetching to ensure remote tags are canonical for version building, fixes would clobber existing tag error(s)

v1.1.0-beta.23 - November 13, 2024

• Changed mvb to never cache the main/base/root build

v1.1.0-beta.22 - November 13, 2024

• Added VPL_MVB_DEV_VERSION to mvb envvars
• Improved get-tags to prefer VPL_MVB_DEV_VERSION as the dev alias if available

v1.1.0-beta.21 - November 11, 2024

• Fixed incorrect lodash-es/uniq.js import in landov3 config set

v1.1.0-beta.20 - November 11, 2024

• Added frontmatter.url-loader to allow .md files to pull content from remote markdown sources
• Fixed frontmatter.editLink to fallback to theme and default text if not passed in

v1.1.0-beta.19 - November 9, 2024

• Added version alias information to config
• Fixed bug preventing user specified buildEnd and transformPageData from running after theme's
• Fixed bug preventing mvb from correctly setting the mvbase
• Fixed duplicate // in generated rss feed
• Improved mvb and root link normalization
• Improved VPLVersionLink to only need version input
• Updated to vitepress@1.5.0

v1.1.0-beta.18 - November 4, 2024

• Fixed bug in normalize-mvb causing multiVersionBuild.build to sometimes not be set correctly
• Fixed lando configset bug causing sidebarEnder to not merge correctly

v1.1.0-beta.17 - November 1, 2024

• Updated GTM tracking

v1.1.0-beta.16 - October 31, 2024

• Added RegEx support for internalDomains matching
• Added get-base-url helper util
• Added is-faux-internal helper util
• Fixed bug causing active to not be correctly set on VPLNavBarMenuGroup
• Improved get-tags and mvb to better handle scenarios with no matchings versions or tags
• Standardized support envars to VPL_ namespacing
• Updated scss and sass compilation to modern-compiler
• Updated to `vitepress@1.4.2`

v1.1.0-beta.15 - October 19, 2024

• Fixed bug with <VPLLink> not dynamically updating and showing strange behavior for prev|next links

v1.1.0-beta.14 - October 3, 2024

• Update default config sets part cinco

v1.1.0-beta.13 - October 2, 2024

• Fixed useTags() to return correct links for sites with non-root base considerations take 2

v1.1.0-beta.12 - October 2, 2024

• Added aliasLinks as an export of useTags()
• Fixed useTags() to return correct links for sites with non-root base considerations

v1.1.0-beta.11 - October 2, 2024

• Update default config sets part четыре

v1.1.0-beta.10 - October 2, 2024

• Update default config sets part tres

v1.1.0-beta.9 - October 2, 2024

• Improved dependency organization

v1.1.0-beta.8 - October 2, 2024

• Update default config sets part deux

v1.1.0-beta.7 - October 2, 2024

• Update default config sets

v1.1.0-beta.6 - October 2, 2024

• Improved dev release resolution
• Fixed prev-next calculation when using sites with non / bases #55

v1.1.0-beta.5 - October 1, 2024

• Changed VPLVersionLink to not normalize links
• Fixed bug in VPLLink causing some links to to not normalize correctly
• Fixed bug causing VPLDocFooter bleed over with some frontmatter combinations of prev and next
• Fixed semver import causing all kinds of chaos when importing this theme as a package

v1.1.0-beta.4 - October 1, 2024

• Added caching to mvb multiversion build
• Added better dev branch detection to mvb
• Fixed bug causing alias.dev to always report highest built tag instead of actual dev version
• Improved robustness of mvb build environment generation

v1.1.0-beta.3 - September 30, 2024

• Improved is-dev-release to handle dev releases that are in front of a prerelease tag

v1.1.0-beta.2 - September 30, 2024

• Fixed bug causing robots.txt build to throw an error when policies is undefined
• Fixed bug causing netlify specific mvb to not get current tags

v1.1.0-beta.1 - September 30, 2024

New Features

• Added new multiversion-vitepress-build command
• Added useTags composable to get docs version information from git
• Added VPLVersionLink component
• Switched these docs to multiversion-vitepress-build
• Updated to `vitepress@1.3.4`

Bug Fixes

• Fixed bug causing build error when metadata is added to a page with no git history
• Fixed bug caused by icon being a variable instead of a string in VPLTeamMembersItem
• Fixed bug caused by VPLTeamMembers.members typing as Object instead of Array
• Fixed bug causing robots.txt policies to not be applied when using policies instead of policy
• Fixed watch bug on VPLCollectionItems preventing tag toggling from working correctly

v1.0.2 - April 17, 2024

• Updated lando config sets
• Updated to `vitepress@1.1.0`

v1.0.1 - April 4, 2024

Bug Fixes

• Fixed bug causing auto population of authors from contributors when authors is empty

v1.0.0 - April 4, 2024

New Features

• Added maintainer key to contributors
• Added rtfm47 to the debotify protocol
• Updated to `vitepress@1.0.2`

v1.0.0-beta.42 - April 2, 2024

New Features

• Improved sponsors.data to accept a URL that returns json or yaml

v1.0.0-beta.41 - March 28, 2024

Fixes

• Checked if authors is defined by @mtdvlpr in https://github.com/lando/vitepress-theme-default-plus/pull/32
• Converted undefined authors to empty array by @mtdvlpr in https://github.com/lando/vitepress-theme-default-plus/pull/30
• Falled back to empty array for authors by @mtdvlpr in https://github.com/lando/vitepress-theme-default-plus/pull/31

v1.0.0-beta.40 - March 5, 2024

New Features

• Added mergeWith for more explicit contrubutor merging
• Updated to `vitepress@1.0.0-rc.44`

Fixes

• Changed member data to only render if available #27
• Fixed Algolia search from displaying contrib information in source text, requires reindexing on Algolia end
• Fixed Algolia search from attempting to route to internal pages that are actually external

Internal

• Changed VPLTeamMembersItem.vue to wrap name in div instead of h1

v1.0.0-beta.39 - February 17, 2024

Fixes

• Fixed: don't enable carbonAds by default by @mtdvlpr in https://github.com/lando/vitepress-theme-default-plus/pull/26
• Fixed: correctly compute hlocation by @mtdvlpr in https://github.com/lando/vitepress-theme-default-plus/pull/24

New Contributors

• @mtdvlpr made their first contribution in https://github.com/lando/vitepress-theme-default-plus/pull/26

Full Changelog: https://github.com/lando/vitepress-theme-default-plus/compare/v1.0.0-beta.38...v1.0.0-beta.39

v1.0.0-beta.38 - February 15, 2024

• Fixed layouts resolution when ingesting theme

v1.0.0-beta.37 - February 15, 2024

• Added color, icon, styles and tagClass properties to <VPLCollectionTag>
• Fixed some styling bugs in <VPLCollectionTag>
• Simplified useCollection tagging to an all purpose tags export

v1.0.0-beta.36 - February 14, 2024

• Improved exportability of non-essentials

v1.0.0-beta.35 - February 14, 2024

• Switched lodash to lodash-es because 🤦

v1.0.0-beta.34 - February 14, 2024

• Improved design of tagging and related components and composables ❤️

v1.0.0-beta.33 - February 13, 2024

• Updated lando config sets

v1.0.0-beta.32 - February 12, 2024

• Added tagging as a thing
• Improved createContentLoader so it returns additional optional frontmatter but removes unneeded props for performance reasons

v1.0.0-beta.31 - February 9, 2024

• AUTO DEPLOY FIX 2

v1.0.0-beta.30 - February 9, 2024

• AUTO DEPLOY FIX 1

v1.0.0-beta.29 - February 8, 2024

• Fixed broken internalDomains handling to force target=_self

v1.0.0-beta.28 - February 7, 2024

• Update sponsor linx

v1.0.0-beta.27 - February 7, 2024

• Fixed bug causing vitepress build failures on non-file git log locations
• Fixed bug causing VPLCollectionIcon.vue to not render correctly on a hard refresh

v1.0.0-beta.26 - February 7, 2024

• Updated to `vitepress@1.0.0-rc.42`

v1.0.0-beta.25 - February 7, 2024

• Guard prev.id and next.id in useCollection like it's nobodies biznizz

v1.0.0-beta.24 - February 2, 2024

• Updated to `vitepress@1.0.0-rc.41`
• Updated sponsors.yaml

v1.0.0-beta.23 - February 1, 2024

• Fixed collection WSOD in some undefined id situations

v1.0.0-beta.22 - January 31, 2024

• Fixed default sidebarEnder for lando config sets

v1.0.0-beta.21 - January 30, 2024

• Added an export for our createContentLoader
• Removed reliance on vite/normalizePath
• TOMLize netlify plugin settings

v1.0.0-beta.20 - January 25, 2024

• Fixed broken base in Lando config sets
• Updated twitter to x

v1.0.0-beta.19 - January 25, 2024

• Improved vite configuration for better portability part 2

v1.0.0-beta.18 - January 25, 2024

• Improved vite configuration for better portability

v1.0.0-beta.17 - January 25, 2024

• Dealias all vitepress components for better portability

v1.0.0-beta.16 - January 25, 2024

• Updated to latest vitepress take 2

v1.0.0-beta.15 - January 25, 2024

• Updated to latest vitepress

v1.0.0-beta.14 - January 25, 2024

• Fixed more extension chaos

v1.0.0-beta.13 - January 25, 2024

• Fixed Cannot find module on enhance-app-with-layouts

v1.0.0-beta.12 - January 24, 2024

• Fixed <Jobs> and <Sponsors> dark mode background color to be more consistent with <CarbonAds>

v1.0.0-beta.11 - January 24, 2024

• Casing matters

v1.0.0-beta.10 - January 24, 2024

• Added ability to append a single menu item to the end of the sidebar with the sidebarEnder config key

v1.0.0-beta.9 - January 24, 2024

• Fixed dependency resolution

v1.0.0-beta.8 - January 24, 2024

• Fixed dependency resolution

v1.0.0-beta.7 - January 24, 2024

• Fixed dependency resolution

v1.0.0-beta.6 - January 24, 2024

• Fixed automatic gitRoot discovery when used outside itself
• Improved base usage
• Migrated lando config sets to VitePress

v1.0.0-beta.5 - January 23, 2024

• Fixed internal import resolutions so theme can be used externally
• Improved install docs to reflect the need to also install vitepress

v1.0.0-beta.4 - January 23, 2024

• Fixed bug causing VPLDocFooter to not show when toggling between a collection and normal doc
• Fixed netlify form input text in dark mode so it is visible
• Fixed broken GitHub support link

v1.0.0-beta.3 - January 23, 2024

• First deploy to npm part 2

v1.0.0-beta.2 - January 23, 2024

• First deploy to npm

v1.0.0-beta.1 - January 23, 2024

• Migrated @lando/vuepress-theme-default-plus to VitePress