https://github.com/tlbootcamp/vuepress-plugin-generate-tree
Vuepress Plugin for generating tree object for each page in locale prefix
https://github.com/tlbootcamp/vuepress-plugin-generate-tree
Last synced: 26 days ago
JSON representation
Vuepress Plugin for generating tree object for each page in locale prefix
- Host: GitHub
- URL: https://github.com/tlbootcamp/vuepress-plugin-generate-tree
- Owner: tlbootcamp
- License: mit
- Created: 2020-05-01T05:43:46.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2023-05-27T10:29:07.000Z (about 3 years ago)
- Last Synced: 2025-02-15T13:49:47.772Z (over 1 year ago)
- Language: TypeScript
- Size: 309 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
vuepress-plugin-generate-tree
Vuepress Plugin for generating tree object with each page in locale prefix
## Sorry, plugin for what?
In our [Teamlead Roadmap](https://github.com/tlbootcamp/tlroadmap) we wanted to generate a tree with pages structure and meta-data.
It is very useful for automatically build sidebar, and vuepress community has [plugin](https://github.com/shanyuhai123/vuepress-plugin-auto-sidebar) for it. But we need not only sidebar, but also meta-data, exporting to file, special ordering, so we decided to create a new specific plugin 🙄 (yes, [NIH syndrome](https://en.wikipedia.org/wiki/Not_invented_here))
Main idea of Teamlead Roadmap is maintaining big mindmap with teamleader's competencies and roles based on VuePress site generator. Web-interface is a good place for beginning, but people want use other mindmap tools and generating other artifacts is a necessity for us. Plugin solves this problem and generate tree of pages with metadata from frontmatter and $page object.
## Install
```sh
yarn add -D @b0g3r/vuepress-plugin-generate-tree
# OR npm install -D @b0g3r/vuepress-plugin-generate-tree
```
## Usage
TODO:
```js
module.exports = {
plugins: [
]
}
```
## Options
TODO: