Giter VIP home page Giter VIP logo

vitepress-auto-nav-sidebar's Introduction

vitepress-auto-nav-sidebar

OSCS Status

vitepress导航栏自动生成

效果预览

Feature

  • 支持功能
    • 自动生成nav和sidebar配置
    • TypeScript支持
    • 目录/文件前缀设置,默认为「 📂 」/「 ✏️ 」
    • 目录/文件的过滤
  • 下一步优化
    • 插件配置待丰富
    • 过滤支持正则

Usage

  1. 安装插件
pnpm i vitepress-auto-nav-sidebar
  1. vuepress配置中使用插件,示例如下
import AutoNavPlugin from 'vitepress-auto-nav-sidebar'

const { nav, sidebar } = AutoNavPlugin({
  ignoreFolders: ["node_modules", "assets", "public", ".vuepress", "code", ".obsidian", "utils"], // 需要排除的一些目录
  ignoreFiles: ['个人简历'], // 需要排除的一些文件
  dirPrefix: '目录:',
  filePrefix: '文件:',
  showNavIcon:false,
  showSideIcon:true,
  isCollapse: true,
  collapsed: true,
  singleLayerNav:true
})
module.exports = {
  themeConfig: {
    nav,
    sidebar,
  },
};

Options

属性 类型 默认值 描述
entry String 'docs' 设置相对于项目根目录的检索入口
singleLayerNav Boolean false 是否设置单层nav
showSideIcon Boolean false 显示sidebar修饰
showNavIcon Boolean true 显示nav修饰
isCollapsible Boolean true sidebar是否可折叠
ignoreFolders String[] [] 需要排除的一些目录
ignoreFiles String[] [] 需要排除的一些文件
filePrefix String ✏️ 文件前缀修饰,有助于区分
dirPrefix String 📂 目录前缀修饰,有助于区分
collapsed Boolean false sidebar默认不折叠
customParentFolderName String '' 自定义侧边栏父文件夹的显示文本,不设置或为空还是默认显示原父文件夹名

vitepress-auto-nav-sidebar's People

Contributors

merlin218 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

vitepress-auto-nav-sidebar's Issues

建议增加参数

1:建议增加参数 设置只遍历搜索 哪个文件名下面的md文档
2:插件左侧列表出现“文章” 这个字可否设置成字段进行修改 ,如果没有设置,则为上级目录名

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.