https://github.com/talltotal/vuepress-theme-talltotal

theme for vuepress
https://github.com/talltotal/vuepress-theme-talltotal

vuepress-theme

Last synced: about 4 hours ago
JSON representation

theme for vuepress

• Host: GitHub
• URL: https://github.com/talltotal/vuepress-theme-talltotal
• Owner: talltotal
• Created: 2019-03-21T09:44:53.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-12-09T03:36:36.000Z (almost 2 years ago)
• Last Synced: 2024-11-08T10:52:20.468Z (11 days ago)
• Topics: vuepress-theme
• Language: Vue
• Homepage: https://talltotal.github.io/vuepress-theme-talltotal/
• Size: 1.05 MB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# vuepress-theme-talltotal

for [vuepress](https://vuepress.vuejs.org/zh/config/#theme)

## 0.x => 1.x

- `frontmatter.layout` => `frontmatter.innerLayout`

## install

```bash

npm install -D vuepress-theme-talltotal

yarn add --dev vuepress-theme-talltotal

```

## why

- style

- auto menu

- themeType：light or dark

    - 优先级：配置设置 > 系统设置 > 默认light

![light](https://talltotal.github.io/vuepress-theme-talltotal/imgs/light.jpg)

![dark](https://talltotal.github.io/vuepress-theme-talltotal/imgs/dark.jpg)

## config

根据配置自动生成菜单：

```js

{

    theme: 'talltotal',

    themeConfig: {

        // config for ‘themeType’

        themeType: 'light', // or dark or undefined

        // config for ‘auto menu’

        // 定义自动生成

        sidebar: 'auto',

        // 配置

        listAllSidebar: {

            // 不在左菜单中显示的文件，打开当前文件时也不会显示左菜单

            ignore: ['/dist/'],

            // 归组做一级目录，key为一级目录名；不归属任何组的页面列在组后

            group: {

                '页面': ['/src/views/'],

                '组件': ['/src/components/'],

            },

        },

    }

}

{

    theme: 'talltotal',

    themeConfig: {

        sidebar: 'auto',

        listAllSidebar: {

            // 模块内的 README.md 目录名，不设置时不会显示在菜单栏，设置时此项会列在左菜单的第一个

            showIndex: 'home',

            // 定义模块，模块内的页面左菜单一致；不归属任何模块的页面合并为一个模块

            modules: ['/work/', '/docs/'],

            // 以文件结构为组，文件夹名为一级目录名，目前最多支持2级；为 true 时，group 配置无效

            groupByDir: true,

        },

    }

}

```