Files
estel_docs/content/docs/1.简单文档/3.writing/3.folders.md
estel be69a51bb2
Some checks failed
CI / lint (push) Has been cancelled
CI / typecheck (push) Has been cancelled
CI / build (ubuntu-latest) (push) Has been cancelled
改回项目内获取md文档
2025-08-08 12:15:35 +08:00

1.6 KiB

title, description, navigation
title description navigation
目录 通过 YML 文件配置目录节点。
icon
lucide:folder

You can customize folders by creating a _dir.yml file in the folder.

::code-group

title: Folder
icon: lucide:folder
navigation.redirect: /frameworks/vue
navBadges:
  - value: New
    type: lime
sidebar:
  style: group
collapse: false
content/
  1.frameworks/
    _dir.yml
    1.vue.md
    2.nuxt.md

::

Parameters

::field-group ::field{name="title" type="string"} Title of the page. Defaults to the filename. :: ::field{name="icon" type="string"} The icon shown in the sidebar for the page. :: ::field{name="navBadges" type="[]"} A list of badges appended to the end of the sidebar link. :: ::field{name="collapse" type="boolean"} Whether the folder should be collapsed by default. :: ::field{name="sidebar" type="object"} ::collapsible{title="Details" default-open} ::field{name="style" type="'default' | 'tree' | 'group'" default-value="default"} The style used for the folder. The default value can be configured in the appConfig.

  |                      `default`                      |                    `tree`                     |                     `group`                     |
  | :-------------------------------------------------: | :-------------------------------------------: | :---------------------------------------------: |
  | ![sidebar-default](/sidebar-default.png){width=400} | ![sidebar-tree](/sidebar-tree.png){width=400} | ![sidebar-group](/sidebar-group.png){width=400} |
  ::
::

:: ::