From c300d95c0338e1382b3f7b57c29e5e7029cb8038 Mon Sep 17 00:00:00 2001
From: Han Wang <44352119+handotdev@users.noreply.github.com>
Date: Thu, 22 Aug 2024 10:56:16 -0700
Subject: [PATCH 1/2] Add new styling configurations
---
settings/global.mdx | 115 ++++++++++++++++++++++++++++++--------------
1 file changed, 80 insertions(+), 35 deletions(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index 450b94b97..e464bf73e 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -16,7 +16,7 @@ settings. Learn more about the [properties](#properties) or from an
Name of your company or project. Used for the global title.
-
+
Path to logo image or object with path to "light" and "dark" mode logo images,
and where the logo links to. SVG format is recommended. It does not pixelate
and the file size is generally smaller.
@@ -66,15 +66,29 @@ settings. Learn more about the [properties](#properties) or from an
- A preset theme configuration that changes the layout of your docs. Examples:
+ A preset theme configuration that changes the look and feel of the project. A theme is a set of default styling configurations.
+
+ Examples:
[Venus](https://starter-venus.mintlify.app),
[Quill](https://starter-quill.mintlify.app),
[Prism](https://starter-prism.mintlify.app)
+
+ The layout of the project. Setting it to `topnav` will feature the top bar as the primary navigation. Setting it to `sidenav` will feature the sidebar. The `solidSidenav` will have an active sidenav.
+
+
+
+ Set a decorative background
+
+
+ The style of the decorative background
+
+
+
+
- A background image to be displayed behind every page. See example with
- [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
+ Set a custom background image to be displayed behind every page.
@@ -88,26 +102,52 @@ settings. Learn more about the [properties](#properties) or from an
Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:
- ```json Only Dark Mode
- "modeToggle": {
- "default": "dark",
- "isHidden": true
- }
- ```
-
- ```json Only Light Mode
- "modeToggle": {
- "default": "light",
- "isHidden": true
- }
- ```
+
+```json Only Dark Mode
+"modeToggle": {
+ "default": "dark",
+ "isHidden": true
+}
+```
+
+```json Only Light Mode
+"modeToggle": {
+ "default": "light",
+ "isHidden": true
+}
+```
+
+
+
+
+
+ Styling configurations for components of the sidebar
+
+
+ The styling of the navigation item.
+
+
+
+ Styling configurations for the topbar.
+
+
+ The styling of the navigation item.
+
+
+ The location of the search bar entry.
+
+
+
+ The style of the rounded edges.
+
+
### Structure
@@ -159,7 +199,12 @@ settings. Learn more about the [properties](#properties) or from an
Text inside the button. Only required if type is a link.
-
+
+ The style of the button.
+
+
+ Whether to display the arrow
+
@@ -202,10 +247,10 @@ settings. Learn more about the [properties](#properties) or from an
-
+
Override the default configurations for the top-most anchor. Note: if you have
tabs configured, this does not apply.
-
+
The name of the top-most anchor
@@ -254,12 +299,12 @@ Example:
An object of social media accounts where the key:property pair represents the social media platform and the account url.
Example:
- ```json
- {
- "x": "https://x.com/mintlify",
- "website": "https://mintlify.com"
- }
- ```
+```json
+{
+ "x": "https://x.com/mintlify",
+ "website": "https://mintlify.com"
+}
+```
One of the following values `website`, `facebook`, `x`, `youtube`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
@@ -378,15 +423,15 @@ Example:
Examples:
- ```json Absolute
- "openapi": "https://example.com/openapi.json"
- ```
- ```json Relative
- "openapi": "/openapi.json"
- ```
- ```json Multiple
- "openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
- ```
+```json Absolute
+"openapi": "https://example.com/openapi.json"
+```
+```json Relative
+"openapi": "/openapi.json"
+```
+```json Multiple
+"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
+```
From 490cd75c0404f94dabfdc397149d830190a38591 Mon Sep 17 00:00:00 2001
From: Han Wang <44352119+handotdev@users.noreply.github.com>
Date: Thu, 22 Aug 2024 14:02:07 -0700
Subject: [PATCH 2/2] Adjust description for sidebar
---
settings/global.mdx | 8 ++++----
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/settings/global.mdx b/settings/global.mdx
index e464bf73e..5f24851e9 100644
--- a/settings/global.mdx
+++ b/settings/global.mdx
@@ -75,14 +75,14 @@ settings. Learn more about the [properties](#properties) or from an
- The layout of the project. Setting it to `topnav` will feature the top bar as the primary navigation. Setting it to `sidenav` will feature the sidebar. The `solidSidenav` will have an active sidenav.
+ The global layout style of the documentation.
- Set a decorative background
+ Set a decorative background.
- The style of the decorative background
+ The style of the decorative background.
@@ -123,7 +123,7 @@ settings. Learn more about the [properties](#properties) or from an
- Styling configurations for components of the sidebar
+ Customize the styling of components within the sidebar.
The styling of the navigation item.