{"id":13704877,"url":"https://github.com/acrobit/docusaurus-plugin-auto-sidebars","last_synced_at":"2025-05-05T12:32:32.379Z","repository":{"id":39162137,"uuid":"255142530","full_name":"acrobit/docusaurus-plugin-auto-sidebars","owner":"acrobit","description":"A docusaurus plugin that generates the sidebar items automatically by filesystem structure","archived":false,"fork":false,"pushed_at":"2023-01-06T03:19:59.000Z","size":490,"stargazers_count":21,"open_issues_count":27,"forks_count":5,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-11-13T12:40:59.094Z","etag":null,"topics":["docusaurus","docusaurus2","generator","markdown","plugin","sidebar","sidebars","static-site","static-site-generator"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/acrobit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-04-12T18:13:36.000Z","updated_at":"2023-12-12T21:44:49.000Z","dependencies_parsed_at":"2023-02-05T05:01:57.776Z","dependency_job_id":null,"html_url":"https://github.com/acrobit/docusaurus-plugin-auto-sidebars","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrobit%2Fdocusaurus-plugin-auto-sidebars","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrobit%2Fdocusaurus-plugin-auto-sidebars/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrobit%2Fdocusaurus-plugin-auto-sidebars/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/acrobit%2Fdocusaurus-plugin-auto-sidebars/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/acrobit","download_url":"https://codeload.github.com/acrobit/docusaurus-plugin-auto-sidebars/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252497665,"owners_count":21757656,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docusaurus","docusaurus2","generator","markdown","plugin","sidebar","sidebars","static-site","static-site-generator"],"created_at":"2024-08-02T22:00:22.148Z","updated_at":"2025-05-05T12:32:31.835Z","avatar_url":"https://github.com/acrobit.png","language":"JavaScript","readme":"\n\u003cp \u003e\n\u003ca href=\"https://www.npmjs.com/package/docusaurus-plugin-auto-sidebars\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/docusaurus-plugin-auto-sidebars.svg?style=flat\" alt=\"npm version\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Installation\n\n```bash\nyarn add docusaurus-plugin-auto-sidebars\n```\n\nor\n\n```bash\nnpm install docusaurus-plugin-auto-sidebars --save\n```\n\n## Usage\n1. Create an empty `sidebars.auto.js` in the root of the project\n\n2. Add this plugin to the `plugins` array in `docusaurus.config.js` :\n\n\n```js\nmodule.exports = {\n  // ...\n  plugins: [\n    'docusaurus-plugin-auto-sidebars'\n  ],\n}\n```\nOr, if you want to specify a custom `docs` folder:\n\n```js\nmodule.exports = {\n  // ...\n  plugins: [\n    ['docusaurus-plugin-auto-sidebars', {\n      docs:'mydocs'\n    }]\n  ],\n}\n```\n##### How to change the title of the folders?\n\nJust add a `sidebars.yaml` in your `docs` folder:\n```yaml\n- folder1: \n  - Parent Folder One # First element is the title of parent, next elements are sub directories\n  - subfolder1: Sub Folder One\n  - subfolder2: Sub Folder Two\n  - subfolder3: false # Hide it!\n  \n- folder2: \n  - Parent Folder Two # First element is the title\n  - subfolder1: Sub Folder One\n  - subfolder2: Sub Folder Two\n\n```\n##### How to change the order of the files and the folders?\n**Method 1**: By adding a number to the beggining of files and folders\n```shell\n1.fileX.md\n2.fileY.md\n3.fileX.md\n```  \nNote : You can also use **negative numbers** to display them in reverse order : `-1. fileX.md`\n\n**Method 2**: Define them in the `sidebars.yaml` file\n\n```yaml\n- folder1: \n  - Parent Folder One: 1 # the order number beside the title\n  - subfolder1: Sub Folder One\n  - subfolder2: Sub Folder Two\n  \n- folder2: \n  - Parent Folder Two: 2 # the order number beside the title\n  - subfolder1: Sub Folder One\n  - subfolder2: Sub Folder Two\n\n```\n\n\n","funding_links":[],"categories":["Plugins"],"sub_categories":["Sidebars"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrobit%2Fdocusaurus-plugin-auto-sidebars","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Facrobit%2Fdocusaurus-plugin-auto-sidebars","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Facrobit%2Fdocusaurus-plugin-auto-sidebars/lists"}