vitepress-plugin-filelist
v0.13.8
Published
OpenList file browser for VitePress: browse, preview, search and batch-download OpenList files in a docs page, with folder passwords, paging and light / dark themes.
Maintainers
Readme
Features
- Folder tree loaded on demand; tick files or folders and download them as one ZIP
- Preview in a dialog: images, audio, video, text, PDF, Markdown / HTML
- Folder passwords, filter and deep search, paging for long folders
- Follows the site theme's colours and light / dark mode (VitePress, or VuePress with the default theme, plume or hope); a compact layout on phones
Install
VitePress 1.6+ or 2
npm install -D vitepress-plugin-filelistRegister with enhanceAppWithFileList, or as a vitepress-tuck plugin: setup guide.
VuePress 2
npm install -D vuepress-plugin-filelistAdd fileListPlugin() to plugins: setup guide.
Then on any page (without base it shows built-in demo data):
<FileList base="https://pan.example.com" path="/course" locale="en-US" />Both packages are the same component with the same version, released together.
Docs and live demo
👉 nrjycyd.github.io/filelist/en/: setup, every prop, and live examples you can click through.
Backend
- API: OpenList
- Tested on: OpenList-Worker
