xref: /aosp_15_r20/external/jspecify/docs/sidebars.js (revision 2167191df2fa07300797f1ac5b707370b5f38c48)
1/*
2 * Copyright 2022 The JSpecify Authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *     http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17/**
18 * Creating a sidebar enables you to:
19 - create an ordered group of docs
20 - render a sidebar for each doc of that group
21 - provide next/previous navigation
22
23 The sidebars can be generated from the filesystem, or explicitly defined here.
24
25 Create as many sidebars as you want.
26 */
27
28// @ts-check
29
30/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
31const sidebars = {
32  // By default, Docusaurus generates a sidebar from the docs folder structure
33  tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
34
35  // But you can create a sidebar manually
36  /*
37  tutorialSidebar: [
38    {
39      type: 'category',
40      label: 'Tutorial',
41      items: ['hello'],
42    },
43  ],
44   */
45};
46
47module.exports = sidebars;
48