npm package: @ogs-gmbh/vitepress-plugin-sidebar
Description: A VitePress plugin that automatically generates sidebar structures by statically analyzing the documentation file system and metadata.
Author: OGS GmbH
Latest version: 1.0.3

> *We're OGS, check out our work on [github.com/ogs-gmbh](https://github.com/ogs-gmbh)*

# VitePress Sidebar

*A VitePress plugin that automatically generates sidebar structures by statically analyzing the documentation file system and metadata.* 

![Preview](./docs/preview.avif)

<a href="./LICENSE" target="_blank"><img alt="license badge" src="https://img.shields.io/github/license/OGS-GmbH/vitepress-plugin-sidebar?color=0f434e&logo=hackthebox&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://github.com/OGS-GmbH/vitepress-plugin-sidebar/actions/workflows/main-deploy.yml" target="_blank"><img alt="workflow badge" src="https://img.shields.io/github/actions/workflow/status/OGS-GmbH/markdown/main-deploy.yml?color=0f434e&logo=rocket&logoColor=000000&labelColor=ffffff" /></a>
<a href="https://www.npmjs.com/package/@ogs-gmbh/vitepress-plugin-sidebar" target="_blank"><img alt="npm badge" src="https://img.shields.io/npm/v/%40ogs-gmbh%2Fmarkdown?color=0f434e&logo=npm&logoColor=000000&labelColor=ffffff" /></a>

- **File System–Based Analysis**\
  Derives the sidebar structure directly from the documentation directory hierarchy.

- **Zero-Configuration Setup**\
  Eliminates the need for manual sidebar definitions in VitePress config files.

- **Nested Hierarchy Support**\
  Accurately represents multi-level sections and document groupings.

- **Static Build-Time Execution**\
  Performs all computations at build time with no runtime overhead.

## Getting Started

> [!IMPORTANT]
> We're offering an extensive API-Reference covered with in-depth usage examples of this project.

To get a starting point, simply refer to our documentation at [ogs-gmbh.github.io/vitepress-plugin-sidebar](https://ogs-gmbh.github.io/vitepress-plugin-sidebar).

## Prerequisites

- Node.js version 18 or higher
- A VitePress project
- A package manager: e.g. npm, pnpm, ...

## Installation

Using npm:
```sh
$ npm install -D @ogs-gmbh/vitepress-plugin-sidebar
```

<details>
  <summary>Using a different package managers?</summary>
  <br/>
  
  Using yarn:
  ```sh
  $ pnpm add -D @ogs-gmbh/vitepress-plugin-sidebar
  ```
  
  Using pnpm:
  ```sh
  $ pnpm add -D @ogs-gmbh/vitepress-plugin-sidebar
  ```
  
  Using bun:
  ```sh
  $ bun add -D @ogs-gmbh/vitepress-plugin-sidebar
  ```

</details>

## Usage

Now, just import and use the `sidebarPlugin` inside your [VitePress Site Config](https://vitepress.dev/reference/site-config).

```ts
import { sidebarPlugin } from "@ogs-gmbh/vitepress-plugin-sidebar";

export default {
  themeConfig: {
    sidebar: sidebarPlugin({
      path: "./dist/vitepress-content"
    })
  }
}
```

## License

The MIT License (MIT) - Please have a look at the [LICENSE file](./LICENSE) for more details.

## Contributing
Contributions are always welcome and greatly appreciated. Whether you want to report a bug, suggest a new feature, or improve the documentation, your input helps make the project better for everyone.

Feel free to submit a pull request, issue or feature request.

### Issues and Feature Requests
Reporting an issue or creating a feature request is made by creating a new issue on this repository.

You can create a [new issue or feature request here](../../issues/new/choose).

### Pull Requests
GitHub offers a solid guideline for contributing to open source projects through pull requests, covering key practices. These best practices provide a reliable starting point for making effective contributions.

You can find the [guidelines here](https://docs.github.com/get-started/exploring-projects-on-github/contributing-to-a-project).

### Code Of Conduct
We are committed to keeping a welcoming, inclusive, and respectful community for everyone. To help us achieve this, we kindly ask that you adhere to our [Code of Conduct](./CODE_OF_CONDUCT.md).

## Disclaimer

All trademarks and registered trademarks mentioned are property of their respective owners and are used for identification purposes only. Use of these names does not imply endorsement or affiliation.

This project is a trademark of OGS Gesellschaft für Datenverarbeitung und Systemberatung mbH. The License does not grant rights to use the trademark without permission.

---

<a href="https://www.ogs.de/en/">
  <picture>
    <source
      srcset="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/light.svg"
      media="(prefers-color-scheme: dark)"
    />
    <img height="64" alt="OGS Logo" src="https://raw.githubusercontent.com/OGS-GmbH/.github/refs/tags/v1.0.0/docs/assets/logo/dark.svg"
  </picture>
</a>

Gesellschaft für Datenverarbeitung und Systemberatung mbH

[Imprint](https://www.ogs.de/en/imprint/) | [Contact](https://www.ogs.de/en/contact/) | [Careers](https://www.ogs.de/en/about-ogs/#Careers)