Skip to content

Document sidebar and topbar styling options #4169

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mintlify wants to merge 1 commit into from
+73 −1
Closed

Document sidebar and topbar styling options #4169

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions es/organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,24 @@ Esta sección contiene la referencia completa del archivo `docs.json`.
<ResponseField name="eyebrows" type="&#x22;section&#x22; | &#x22;breadcrumbs&#x22;">
El estilo del eyebrow (encabezado superior) de la página. Elige `section` para mostrar el nombre de la sección o `breadcrumbs` para mostrar la ruta de navegación completa. El valor predeterminado es `section`.
</ResponseField>
<ResponseField name="sidebar" type="object">
Configuración de estilo de la barra lateral.

<Expandable title="Sidebar">
<ResponseField name="items" type="&#x22;container&#x22; | &#x22;card&#x22; | &#x22;border&#x22; | &#x22;undecorated&#x22;">
Estilo visual para los elementos de navegación de la barra lateral. Elige `container` para elementos agrupados con un fondo sutil, `card` para elementos con estilo de tarjeta elevada, `border` para elementos con un borde sutil, o `undecorated` para un estilo minimalista. El valor predeterminado varía según el tema.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="topbar" type="object">
Configuración de estilo de la barra superior.

<Expandable title="Topbar">
<ResponseField name="style" type="&#x22;gradient&#x22; | &#x22;default&#x22;">
Estilo visual para la barra de navegación. Elige `gradient` para un efecto de fondo degradado o `default` para un estilo estándar. El valor predeterminado es `default`.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="latex" type="boolean">
Controla si se incluyen las hojas de estilo de LaTeX, anulando la detección automática. De forma predeterminada, Mintlify detecta automáticamente el uso de LaTeX en tu contenido y carga las hojas de estilo necesarias.
Expand Down
20 changes: 19 additions & 1 deletion fr/organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,25 @@ Cette section présente la référence complète du fichier `docs.json`.

<Expandable title="Style">
<ResponseField name="eyebrows" type="&#x22;section&#x22; | &#x22;breadcrumbs&#x22;">
Le style de l’eyebrow de la page. Choisissez `section` pour afficher le nom de la section ou `breadcrumbs` pour afficher le chemin de navigation complet. Par défaut, la valeur est `section`.
Le style de l'eyebrow de la page. Choisissez `section` pour afficher le nom de la section ou `breadcrumbs` pour afficher le chemin de navigation complet. Par défaut, la valeur est `section`.
</ResponseField>
<ResponseField name="sidebar" type="object">
Configuration du style de la barre latérale.

<Expandable title="Sidebar">
<ResponseField name="items" type="&#x22;container&#x22; | &#x22;card&#x22; | &#x22;border&#x22; | &#x22;undecorated&#x22;">
Style visuel pour les éléments de navigation de la barre latérale. Choisissez `container` pour des éléments groupés avec un arrière-plan subtil, `card` pour des éléments en style carte surélevée, `border` pour des éléments avec une bordure subtile, ou `undecorated` pour un style minimaliste. La valeur par défaut varie selon le thème.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="topbar" type="object">
Configuration du style de la barre supérieure.

<Expandable title="Topbar">
<ResponseField name="style" type="&#x22;gradient&#x22; | &#x22;default&#x22;">
Style visuel pour la barre de navigation. Choisissez `gradient` pour un effet de fond dégradé ou `default` pour un style standard. Par défaut, la valeur est `default`.
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="latex" type="boolean">
Expand Down
18 changes: 18 additions & 0 deletions organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,24 @@
<ResponseField name="eyebrows" type='"section" | "breadcrumbs"'>
The style of the page eyebrow. Choose `section` to show the section name or `breadcrumbs` to show the full navigation path. Defaults to `section`.
</ResponseField>
<ResponseField name="sidebar" type="object">
Sidebar styling configuration.

<Expandable title="Sidebar">
<ResponseField name="items" type='"container" | "card" | "border" | "undecorated"'>
Visual style for sidebar navigation items. Choose `container` for grouped items with a subtle background, `card` for elevated card-style items, `border` for items with a subtle border, or `undecorated` for minimal styling. The default varies by theme.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="topbar" type="object">
Topbar styling configuration.

<Expandable title="Topbar">
<ResponseField name="style" type='"gradient" | "default"'>
Visual style for the navigation bar. Choose `gradient` for a gradient background effect or `default` for standard styling. Defaults to `default`.
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="latex" type="boolean">
Controls whether LaTeX stylesheets are included, overriding automatic detection. By default, Mintlify automatically detects LaTeX usage in your content and loads the necessary stylesheets.

Expand Down Expand Up @@ -348,11 +366,11 @@
</ResponseField>

<ResponseField name="variables" type="object">
Global variables for use throughout your documentation. Variables are replaced at build time using `{{variableName}}` syntax.

Check warning on line 369 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L369 

In general, use active voice instead of passive voice ('are replaced').

<Expandable title="Variables">
<ResponseField name="variableName" type="string">
A key-value pair where the key is the variable name and the value is the replacement text. All variables referenced in your content must be defined, or the build fails. Variable names can contain alphanumeric characters, hyphens, and periods. Values are sanitized to prevent XSS attacks.

Check warning on line 373 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L373 

In general, use active voice instead of passive voice ('be defined').

Check warning on line 373 in organize/settings.mdx

View check run for this annotation

Mintlify / Mintlify Validation (mintlify) - vale-spellcheck

organize/settings.mdx#L373 

In general, use active voice instead of passive voice ('are sanitized').
</ResponseField>
</Expandable>
</ResponseField>
Expand Down
18 changes: 18 additions & 0 deletions zh/organize/settings.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,24 @@ import IconsOptional from "/snippets/zh/icons-optional.mdx";
<ResponseField name="eyebrows" type="&#x22;section&#x22; | &#x22;breadcrumbs&#x22;">
页面 eyebrow 区域的样式。选择 `section` 显示所属章节名称，选择 `breadcrumbs` 显示完整导航路径。默认为 `section`。
</ResponseField>
<ResponseField name="sidebar" type="object">
侧边栏样式配置。

<Expandable title="Sidebar">
<ResponseField name="items" type="&#x22;container&#x22; | &#x22;card&#x22; | &#x22;border&#x22; | &#x22;undecorated&#x22;">
侧边栏导航项的视觉样式。选择 `container` 显示带有微妙背景的分组项，`card` 显示悬浮卡片样式项，`border` 显示带有微妙边框的项，或 `undecorated` 显示极简样式。默认值因主题而异。
</ResponseField>
</Expandable>
</ResponseField>
<ResponseField name="topbar" type="object">
顶部栏样式配置。

<Expandable title="Topbar">
<ResponseField name="style" type="&#x22;gradient&#x22; | &#x22;default&#x22;">
导航栏的视觉样式。选择 `gradient` 应用渐变背景效果，或选择 `default` 使用标准样式。默认为 `default`。
</ResponseField>
</Expandable>
</ResponseField>

<ResponseField name="latex" type="boolean">
控制是否包含 LaTeX 样式表，并覆盖自动检测。默认情况下，Mintlify 会自动检测内容中的 LaTeX 使用情况并加载所需的样式表。
Expand Down