ulivz / vt Goto Github PK

View Code? Open in Web Editor NEW

137.0 3.0 11.0 4.38 MB

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

Home Page: https://vt.insx.dev

License: MIT License

Vue 59.92% JavaScript 11.65% CSS 0.25% TypeScript 11.83% Stylus 16.34%

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

vt's Introduction

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.

Features

Compatibility: fully compatible with VuePress's Default Theme.
Full-text search: No server dependencies, distinguishing locales.
Dark Mode
Enhanced Sidebar: Nested Sidebar Group、Sidebar Nav Links.
TypeScript Support
Homepage
API Page
Global Status
Code Switcher
i18n, Code Copy, TOC, etc.
...

Motivation

I made this theme to combine better eXperience and current huge VuePress ecosystem, and introducing some built-in features like Full-text search, i18n etc.

Install

npm i vuepress-theme-vt -D

Usage

// .vuepress/config.js
module.exports = {
  theme: "vt",
};

Prior Art

vuepress-theme-vt won't exist without @vue/theme and VuePress ecosystem:

vuepress-plugin-fulltext-search, by @leo-buneev.
icones, by @antfu.

LICENSE

MIT License © ULIVZ

vt's People

Contributors

Stargazers

Watchers

Forkers

skychx spencerht asiainfoliwei lp0124 leijunluo 00zhengfu00 sanyuan0704 0xlau bryan31

vt's Issues

[bug] dropdown group links styling issue

bug: no-sidebar page‘s h1 header is too narrow

[bug] search box does not hidden

[bug] narrow screen layout issue

Snapshot

[feature request] new badge component

[bug] mobile layout issue under dark mode

Summary

hightligh problem when use diff

```diff
<!DOCTYPE html>
<html>
<head>
</head>
<body>
  <div id="root"></div>
- <script src="/index-CH27MJVK.js" type="module"></script>
+ <script src="http://www.speedy.dev/index-CH27MJVK.js" type="module"></script>
</body>
</html>
```

when i use diff it generate the following result

but it renders nicely in github | vscode

<!DOCTYPE html>
<html>
<head>
</head>
<body>
  <div id="root"></div>
- <script src="/index-CH27MJVK.js" type="module"></script>
+ <script src="http://www.speedy.dev/index-CH27MJVK.js" type="module"></script>
</body>
</html>

feature request: generate h3 with indent at API Page

Typographic replacements and enabling markdown-it plugins.

Question. I'm attempting to follow the docs and I'm a bit lost on typographic replacements. Can you give a little more detail on how to enable typographer? Would enabling this fix the numbered lists so that they are actually numbered. See example here of them not actually being numbered.

Last question, where do I enable the markdown-it plugins? I thought it would be in the .vuepress/config.ts file, like this:

import { ThemeConfig } from "vuepress-theme-vt";
import { defineConfig4CustomTheme } from "vuepress/config";

export = defineConfig4CustomTheme<ThemeConfig>((ctx) => ({
  theme: "vt",
  title: "Title",
  plugins: [
    [
      'HERE?'
    ]
  themeConfig: {
    enableDarkMode: true,

Thanks in advance!

[bug]: nav links can't show Dropdown by overflow-x

After the [email protected], nav-links add overflow-x: scroll to fix narrow sceen, but unfortunately block inner DOM.

with overflow-x: scroll.

without overflow-x: scroll.

bug: adjust page content layout when sidebar is disabled

API Index Page

[feature request] code switcher

ref: https://github.com/padarom/vuepress-plugin-code-switcher

Custom External Link Icon at Sidebar

[bug] gradient text at dark mode

[issue] [android] mobile sidebar group title color issue at dark mode

[bug] TypeError: Cannot read properties of undefined (reading 'map')

Summary

Once you config a path without children at API page:

{
  title: "API Reference",
  path: "/api/",
},

You'll get following error:

vue.runtime.esm.js?84a7:1897 TypeError: Cannot read properties of undefined (reading 'map')
    at eval (API.vue?a295:25:1)
    at Array.map (<anonymous>)
    at VueComponent.apiGroups (API.vue?a295:21:1)
    at Watcher.get (vue.runtime.esm.js?84a7:4495:1)
    at Watcher.evaluate (vue.runtime.esm.js?84a7:4597:1)
    at VueComponent.computedGetter [as apiGroups] (vue.runtime.esm.js?84a7:4851:1)
    at VueComponent.filtered (API.vue?a295:44:1)
    at Watcher.get (vue.runtime.esm.js?84a7:4495:1)
    at Watcher.evaluate (vue.runtime.esm.js?84a7:4597:1)
    at VueComponent.computedGetter [as filtered] (vue.runtime.esm.js?84a7:4851:1)

[feature request] custom external link icon at doc content

[feature request] i18n generator

[bug] missing padding when hero text is multiple-lined

[bug] cannot resolve AlgoliaSearchBox.

[docs] cn documentation

[feature request] support page layout

Motivation

Currently if we want to custom the page's layout (e.g. hidden sidebar, toc and pageEdit), we need hidden it via frontmatter one by one:

---
toc: false
pageEdit: false
sidebar: false
---

And after #42 is merged, the page' container style is not aligned and is hard to control, it's not friendly for users who only wants to use a fully different page layout and only remain Header.

API Design

Introduce a new frontmatter option BlogPage:

---
pageLayout: BlogPage
---

The the page will be rendered with the component, and we don't need to hack any internal styles.

Summary

https://vuepress-theme-vt.vercel.app/

2.82f54902.js:1 Uncaught ReferenceError: SEARCH_HOTKEYS is not defined
at a.onHotkey (2.82f54902.js:1:30042)

 ├── docs
 │   ├── api
+│   │   ├── config-foo.md
+│   │   ├── config-bar.md
+│   │   ├── config-baz.md
+│   │   └── index.md
-│   ├── guide
 │   │   ├── getting-started.md
 │   │   ├── index.md
 │   │   └── ...
 │   └── index.md
 └── package.json

Summary

[feature request] add little dinosaur for dark mode

Summary

[feature request] Details and Summary Component

[bug] styling issue of six items features

```sh{4}
  asset-demo
  |- package.json
  |- package-lock.json
  |- speedy.config.ts
  |- /dist
    |- bundle.js
    |- index.html
  |- /src
+   |- style.css
    |- index.js
  |- /node_modules
```

generates

Replace built-in search with full-text search

[bug] failed to init project

Step to repro

npm create vt my-vt

add vuepress2 support

[feature request] set default sidebar depth to 0

Summary

Hidden duplicate TOC at sidebar by default:

ulivz / vt Goto Github PK

vt's Introduction

VT

Status

Features

Motivation

Install

Usage

Prior Art

Sponsors

LICENSE

vt's People

Contributors

Stargazers

Watchers

Forkers

vt's Issues

Snapshot

Summary

Summary

Motivation

API Design

Summary

Summary

Summary

Snapshot

Step to repro

Summary

Recommend Projects

Recommend Topics

Recommend Org

Jobs