https://github.com/ulivz/vt

🖼️ A "Post-VuePress Era" Documentation Theme (Deprecation Warning: For a next-gen SSG, please check out Rspress.)
https://github.com/ulivz/vt

vitepress vt vue vuejs vuepress vuepress-theme vuepress-theme-vt

Last synced: 8 days ago
JSON representation

🖼️ A "Post-VuePress Era" Documentation Theme (Deprecation Warning: For a next-gen SSG, please check out Rspress.)

• Host: GitHub
• URL: https://github.com/ulivz/vt
• Owner: ulivz
• License: mit
• Created: 2021-12-16T16:18:21.000Z (almost 3 years ago)
• Default Branch: master
• Last Pushed: 2023-11-02T07:20:31.000Z (about 1 year ago)
• Last Synced: 2024-10-31T16:58:02.792Z (15 days ago)
• Topics: vitepress, vt, vue, vuejs, vuepress, vuepress-theme, vuepress-theme-vt
• Language: Vue
• Homepage: https://vt.insx.dev
• Size: 4.28 MB
• Stars: 135
• Watchers: 3
• Forks: 10
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        








    

    


    
VT




  A "Post-VuePress Era" Documentation Theme










  📖 Live Documentation


  📚 VuePress Docs With This Theme









## Status

VT is now in maintenance mode and will be deprecated in the future. For a next-gen SSG, please check out [Rspress](https://rspress.dev/).

## Features

- [**Compatibility**](https://vt.insx.dev/guide/migration.html): fully compatible with [VuePress's Default Theme](https://vuepress.vuejs.org/theme/default-theme-config.html).

- [**Full-text search**](https://vt.insx.dev/guide/search.html): No server dependencies, distinguishing locales.

- [Dark Mode](https://vt.insx.dev/guide/dark-mode.html)

- Enhanced Sidebar: [Nested Sidebar Group](https://vt.insx.dev/guide/sidebar.html#nested-sidebar-group)、[Sidebar Nav Links](https://vt.insx.dev/guide/sidebar.html#sidebar-nav-links).

- [TypeScript Support](https://vt.insx.dev/guide/configuration.html)

- [Homepage](https://vt.insx.dev/guide/home.html)

- [API Page](https://vt.insx.dev/guide/api-page.html)

- [Global Status](https://vt.insx.dev/guide/status.html)

- [Code Switcher](https://vt.insx.dev/guide/code-switcher.html)

- i18n, Code Copy, TOC, etc.

- ...

## Motivation

I made this theme to combine better **eXperience** and [current huge VuePress ecosystem](https://github.com/vuepress/awesome-vuepress/), and introducing some built-in features like [Full-text search](https://vt.insx.dev/guide/search.html), **i18n** etc.

## Install

```bash

npm i vuepress-theme-vt -D

```

## Usage

```js

// .vuepress/config.js

module.exports = {

  theme: "vt",

};

```

## Prior Art

`vuepress-theme-vt` won't exist without `@vue/theme` and [VuePress ecosystem](https://github.com/vuepress/awesome-vuepress/):

- [vuepress-plugin-fulltext-search](https://github.com/leo-buneev/vuepress-plugin-fulltext-search), by [@leo-buneev](https://github.com/leo-buneev).

- [icones](https://icones.js.org/), by [@antfu](https://icones.js.org/).

## Sponsors

If my code has helped you, please consider sponsoring me. I'd like to thank these awesome companies for sponsoring me:

  

    

      

        

          

        

      

    

  

You can donate through the following channels:

- [Become a backer or sponsor on Patreon.](https://www.patreon.com/ulivz).

- Github Sponsors (WIP).

## LICENSE

MIT License © [ULIVZ](https://github.com/ulivz)