Skip to content

Commit

Permalink
README
Browse files Browse the repository at this point in the history
  • Loading branch information
pirog committed Jan 23, 2024
1 parent d2375b3 commit 4dba89b
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 32 deletions.
50 changes: 20 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,42 +1,32 @@
# VuePress 2 Default Theme +

This extends the [default VuePress 2 theme](https://v2.vuepress.vuejs.org/reference/default-theme/config.html#basic-config) with some extra power and features such as:

* Easily distributable default config sets and shared navbar items
* Additional `containers` to help spruce up your Markdown
* Google Analytics/Tag Manager support
* HubSpot tracking code support
* Automatic metatag generation
* Features to help combining different docs sites into a single coherent docs experience
* `Docsearch` support
* Customizable `SidebarHeader` header for more larger and more complex sites
* Automatically generated and customizable _Previous Versions_ page
* Automatically generated and customizable _Contributorz_ page
* Additional `Guide` page type
* Additional global components for `YouTube` and `MailChimp`
* `robots.txt` and `sitemap.xml` generation
* [CarbonAds](https://www.carbonads.net/) support

Note that autogeneration of contributors and versioning information currently only works with GitHub. You can, however, manually populate these values for other VCS for now.
# VitePress Default Theme +

This extends the [default VitePress theme](https://vitepress.dev/) with some extra power and features such as:

<div align="center">
![features](./docs/public/images/features.png)
</div>

Or just go to the [docs](https://vitepress-theme-default-plus.lando.dev) for the docs to learn more.

## Docs

* [Overview](https://vuepress-theme-default-plus.lando.dev/)
* [Getting Started, Installation and Usage](https://vuepress-theme-default-plus.lando.dev/getting-started.html)
* [Configuration](https://vuepress-theme-default-plus.lando.dev/config.html)
* [Guides](https://vuepress-theme-default-plus.lando.dev/guides.html)
* [Examples](https://github.com/lando/vuepress-theme-default-plus)
* [Development](https://vuepress-theme-default-plus.lando.dev/development.html)
* [Overview](https://vitepress-theme-default-plus.lando.dev/overview)
* [Installation](https://vitepress-theme-default-plus.lando.dev/install.html)
* [Usage](https://vitepress-theme-default-plus.lando.dev/usage.html)
* [Configuration](https://vitepress-theme-default-plus.lando.dev/config/config.html)
* [Guides](https://vitepress-theme-default-plus.lando.dev/guides.html)
* [Examples](https://github.com/lando/vitepress-theme-default-plus)
* [Development](https://vitepress-theme-default-plus.lando.dev/development.html)

## Issues, Questions and Support

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!

If you'd like to report a bug or submit a feature request then please [use the issue queue](https://github.com/lando/vuepress-theme-default-plus.lando.dev/issues/new/choose) in this repo.
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.

## Changelog

We try to log all changes big and small in both [THE CHANGELOG](https://github.com/lando/vuepress-theme-default-plus/blob/main/CHANGELOG.md) and the [release notes](https://github.com/lando/vuepress-theme-default-plus/releases).
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).

## Releasing

Expand All @@ -46,8 +36,8 @@ Note that prereleases will get pushed to the `edge` tag on the `npm` registry.

## Contributors

<a href="https://github.com/lando/vuepress-theme-default-plus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lando/vuepress-theme-default-plus" />
<a href="https://github.com/lando/vitepress-theme-default-plus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=lando/vitepress-theme-default-plus" />
</a>

Made with [contributors-img](https://contrib.rocks).
Expand Down
3 changes: 1 addition & 2 deletions docs/guides.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,7 @@ const {pages} = useCollection('guide');
Guides
</template>
<template #lead>
stuyff adn thiangsoejp
oj pgojseg
Helpful tutorial-like content!
</template>
</VPLCollectionPageTitle>
<VPLCollectionItems :items="pages"/>
Expand Down
Binary file added docs/public/images/features.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4dba89b

Please sign in to comment.