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