feat(theme-classic): auto-collapse sibling categories in doc sidebar

packages/docusaurus/src/webpack/__tests__/utils.test.ts

@@ -135,7 +135,7 @@ describe('extending generated webpack config', () => {
 
 describe('getFileLoaderUtils()', () => {
   test('plugin svgo/removeViewBox should be disabled', () => {
-    const use = getFileLoaderUtils().rules.svg().use;
+    const {use} = getFileLoaderUtils().rules.svg();
     expect(use).toContainEqual(
       expect.objectContaining({
         loader: '@svgr/webpack',

website/docs/deployment.mdx

@@ -50,11 +50,9 @@ First, modify your `docusaurus.config.js` and add the required params:
 | `url` | URL for your GitHub Page's user/organization page. This is commonly https://_username_.github.io. |
 | `baseUrl` | Base URL for your project. For projects hosted on GitHub pages, it follows the format "/_projectName_/". For https://github.com/facebook/docusaurus, `baseUrl` is `/docusaurus/`. |
 
-:::info
-In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment.
+:::info In case you want to use your custom domain for GitHub Pages, create a `CNAME` file in the `static` directory. Anything within the `static` directory will be copied to the root of the `build` directory for deployment.
 
-You may refer to GitHub Pages' documentation [User, Organization, and Project Pages](https://help.github.com/en/articles/user-organization-and-project-pages) for more details.
-:::
+You may refer to GitHub Pages' documentation [User, Organization, and Project Pages](https://help.github.com/en/articles/user-organization-and-project-pages) for more details. :::
 
 Example:
 

website/docs/docs.md

@@ -60,282 +60,6 @@ slug: /
 Lorem ipsum
 ```
 
-## Sidebar
-
-To generate a sidebar to your Docusaurus site, you need to define a file that exports a sidebar object and pass that into the `@docusaurus/plugin-docs` plugin directly or via `@docusaurus/preset-classic`.
-
-```js {8-9} title="docusaurus.config.js"
-module.exports = {
-  // ...
-  presets: [
-    [
-      '@docusaurus/preset-classic',
-      {
-        docs: {
-          // Sidebars filepath relative to the site dir.
-          sidebarPath: require.resolve('./sidebars.js'),
-        },
-        // ...
-      },
-    ],
-  ],
-};
-```
-
-### Hideable sidebar
-
-Using the enabled `themeConfig.hideableSidebar` option, you can make the entire sidebar hided, allowing you to better focus your users on the content. This is especially useful when content consumption on medium screens (e.g. on tablets).
-
-```js {4} title="docusaurus.config.js"
-module.exports = {
-  // ...
-  themeConfig: {
-    hideableSidebar: true,
-    // ...
-  },
-};
-```
-
-### Auto Collapsable Sidebar
-
-Using the enabled `themeConfig.autoCollapseSidebar` option, you can make the sidebar only have one parent category open at a time, helping users not get cluttered and only focus on the content they selected. If you want them to be enable this feature, set `themeConfig.autoCollapseSidebar` to `true`:
-
-```js {4} title="docusaurus.config.js"
-module.exports = {
-  // ...
-  themeConfig: {
-    autoCollapseSidebar: true,
-    // ...
-  },
-};
-```
-
-### Sidebar object
-
-A sidebar object is defined like this:
-
-```typescript
-type Sidebar = {
-  [sidebarId: string]:
-    | {
-        [sidebarCategory: string]: SidebarItem[];
-      }
-    | SidebarItem[];
-};
-```
-
-Below is an example of a sidebar object. The key `docs` is the id of the sidebar (can be renamed to something else) and `Getting Started` is a category within the sidebar. `greeting` and `doc1` are both [sidebar item](#sidebar-item).
-
-```js title="sidebars.js"
-module.exports = {
-  docs: {
-    'Getting started': ['greeting'],
-    Docusaurus: ['doc1'],
-  },
-};
-```
-
-Keep in mind that EcmaScript does not guarantee `Object.keys({a,b}) === ['a','b']` (yet, this is generally true). If you don't want to rely on iteration order of JavaScript object keys for the category name, the following sidebar object is also equivalent of the above shorthand syntax.
-
-```js title="sidebars.js"
-module.exports = {
-  docs: [
-    {
-      type: 'category',
-      label: 'Getting Started',
-      items: ['greeting'],
-    },
-    {
-      type: 'category',
-      label: 'Docusaurus',
-      items: ['doc1'],
-    },
-  ],
-};
-```
-
-You can also have multiple sidebars for different Markdown files by adding more top-level keys to the exported object.
-
-Example:
-
-```js title="sidebars.js"
-module.exports = {
-  firstSidebar: {
-    'Category A': ['doc1'],
-  },
-  secondSidebar: {
-    'Category A': ['doc2'],
-    'Category B': ['doc3'],
-  },
-};
-```
-
-#### Sidebar item
-
-As the name implies, `SidebarItem` is an item defined in a Sidebar. There are a few types we support:
-
-- [Doc](#doc)
-- [Link](#link)
-- [Ref](#ref)
-- [Category](#category)
-
-#### Doc
-
-```typescript
-type SidebarItemDoc =
-  | string
-  | {
-      type: 'doc';
-      id: string;
-    };
-```
-
-Sidebar item type that links to a doc page. Example:
-
-```js
-{
-  type: 'doc',
-  id: 'doc1', // string - document id
-}
-```
-
-Using just the [Document ID](#document-id) is perfectly valid as well, the following is equivalent to the above:
-
-```js
-'doc1'; // string - document id
-```
-
-Note that using this type will bind the linked doc to current sidebar, this means that if you access `doc1` page, the sidebar displayed will be the sidebar this item is on. For below case, `doc1` is bounded to `firstSidebar`.
-
-```js title="sidebars.js"
-module.exports = {
-  firstSidebar: {
-    'Category A': ['doc1'],
-  },
-  secondSidebar: {
-    'Category A': ['doc2'],
-    'Category B': ['doc3'],
-  },
-};
-```
-
-#### Link
-
-```typescript
-type SidebarItemLink = {
-  type: 'link';
-  label: string;
-  href: string;
-};
-```
-
-Sidebar item type that links to a non-document page. Example:
-
-```js
-{
-  type: 'link',
-  label: 'Custom Label', // The label that should be displayed (string).
-  href: 'https://example.com' // The target URL (string).
-}
-```
-
-#### Ref
-
-```typescript
-type SidebarItemRef = {
-  type: 'ref';
-  id: string;
-};
-```
-
-Sidebar item type that links to doc without bounding it to the sidebar. Example:
-
-```js
-{
-  type: 'ref',
-  id: 'doc1', // Document id (string).
-}
-```
-
-#### Category
-
-This is used to add hierarchies to the sidebar:
-
-```typescript
-type SidebarItemCategory = {
-  type: 'category';
-  label: string; // Sidebar label text.
-  items: SidebarItem[]; // Array of sidebar items.
-  collapsed: boolean; // Set the category to be collapsed or open by default
-};
-```
-
-As an example, here's how we created the subcategory for "Docs" under "Guides" in this site:
-
-```js title="sidebars.js"
-module.exports = {
-  docs: {
-    Guides: [
-      'creating-pages',
-      {
-        type: 'category',
-        label: 'Docs',
-        items: ['markdown-features', 'sidebar', 'versioning'],
-      },
-    ],
-  },
-};
-```
-
-**Note**: it's possible to use the shorthand syntax to create nested categories:
-
-```js title="sidebars.js"
-module.exports = {
-  docs: {
-    Guides: [
-      'creating-pages',
-      {
-        Docs: ['markdown-features', 'sidebar', 'versioning'],
-      },
-    ],
-  },
-};
-```
-
-#### Collapsible categories
-
-For sites with a sizable amount of content, we support the option to expand/collapse a category to toggle the display of its contents. Categories are collapsible by default. If you want them to be always expanded, set `themeConfig.sidebarCollapsible` to `false`:
-
-```js {4} title="docusaurus.config.js"
-module.exports = {
-  // ...
-  themeConfig: {
-    sidebarCollapsible: false,
-    // ...
-  },
-};
-```
-
-#### Expanded categories by default
-
-For docs that have collapsible categories, you may want more fine-grain control over certain categories. If you want specific categories to be always expanded, you can set `collapsed` to `false`:
-
-```js title="sidebars.js"
-module.exports = {
-  docs: {
-    Guides: [
-      'creating-pages',
-      {
-        type: 'category',
-        label: 'Docs',
-        collapsed: false,
-        items: ['markdown-features', 'sidebar', 'versioning'],
-      },
-    ],
-  },
-};
-```
-
 ## Docs-only mode
 
 If you only want the documentation feature, you can run your Docusaurus 2 site without a landing page and display your documentation page as the index page instead.

website/docs/sidebar.md

@@ -77,9 +77,7 @@ module.exports = {
 };
 ```
 
-:::note
-Shorthand notation relies on the iteration order of JavaScript object keys for the category name. When using this notation, keep in mind that EcmaScript does not guarantee `Object.keys({a,b}) === ['a','b']`, yet this is generally true.
-:::
+:::note Shorthand notation relies on the iteration order of JavaScript object keys for the category name. When using this notation, keep in mind that EcmaScript does not guarantee `Object.keys({a,b}) === ['a','b']`, yet this is generally true. :::
 
 ## Using multiple sidebars
 
@@ -270,6 +268,20 @@ module.exports = {
 };
 ```
 
+### Auto Collapsable Sidebar
+
+Using the enabled `themeConfig.autoCollapseSidebar` option, you can make the sidebar only have one parent category open at a time, helping users not get cluttered and only focus on the content they selected. If you want them to be enable this feature, set `themeConfig.autoCollapseSidebar` to `true`:
+
+```js {4} title="docusaurus.config.js"
+module.exports = {
+  // ...
+  themeConfig: {
+    autoCollapseSidebar: true,
+    // ...
+  },
+};
+```
+
 #### Expanded categories by default
 
 For docs that have collapsible categories, you may want more fine-grain control over certain categories. If you want specific categories to be always expanded, you can set `collapsed` to `false`: