Skip to content

Commit 9f34c00

Browse files
committed
content splitted to give more clarity
1 parent d8a3f82 commit 9f34c00

File tree

6 files changed

+71
-66
lines changed

6 files changed

+71
-66
lines changed

src/_data/sidebars/help.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,14 @@ resources:
7777
items:
7878
- label: Custom domains
7979
link: /customization-options/custom-domains/
80-
- label: Color, logo and meta images
80+
- label: Branding customization
8181
link: /customization-options/color-logo-meta-images/
8282
- label: Login page
8383
link: /customization-options/login/
8484
- label: Operations & Navigation
8585
link: /customization-options/operations-navigation/
86-
- label: Deep customization, injection & analytics
87-
link: /customization-options/deep-customization-injection-analytics/
86+
- label: Head injection (analytics and tools integration)
87+
link: /customization-options/head-injection-analytics-tools-integration/
8888
- label: Embed mode
8989
link: /customization-options/embed-mode/
9090
- type: category

src/_help/customization-options/color-logo-meta-images.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Color, logo and social media image
2+
title: Branding customization
33
---
44

55
- TOC
@@ -54,6 +54,44 @@ It is advisable not to exceed a width of 1200px and to maintain the height betwe
5454

5555
![Meta image upload](/images/help/meta-image.png)
5656

57+
## Advanced customization through CSS variables
58+
59+
> Deep customization options are available in our [paid plan](https://bump.sh/pricing/).
60+
{: .info}
61+
62+
Bump.sh offers deeper customization options, offering full control of your branding. It makes your Bump.sh doc portal truly blend in with your platform.
63+
64+
Custom CSS can be added either through a [reverse proxy](/help/customization-options/embed-mode/#configure-your-proxy) you've set up (by injecting these variables in the [`head` section of documentation](/help/customization-options/head-injection-analytics-tools-integration/#how-to)), or managed by Bump.sh. Feel free to [contact us](mailto:hello@bump.sh) so we can assist you.
65+
66+
> If you customize fonts, make sure to use a font that is available on the user's device, or loaded in your custom headers.
67+
{: .info}
68+
69+
You can safely customize the style of your doc portal using these CSS variables:
70+
71+
- `--font-family`: the global font family;
72+
- `--heading-font-family`: the font family used for headings (h1, h2, h3, ...). If none is defined, the global font family is displayed;
73+
- `--code-font-family`: the font used for code blocks and examples;
74+
- `--doc-font-size`: the global font size. The default value is 14px;
75+
- `--code-font-size`: the font size used on code blocks and examples. The default value is 12px;
76+
- `--nav-font-size`: the font size used on side and top navigation bars. The default value is 14px;
77+
- `--doc-font-weight`: the default font weight. The default value is 500;
78+
- `--nav-font-weight`: the font weight used on side and top navigation bars. The default value is 500;
79+
- `--logo-width`: logo width, if the default width doesn't fit your logo width;
80+
- `--logo-height`: logo height, if the default height doesn't fit your logo height;
81+
- `--doc-success-color`: the color used for success messages;
82+
- `--doc-error-color`: the color used for error messages;
83+
- `--doc-warning-color`: the color used for warning messages;
84+
- `--doc-warning-light-color`: the color used for warning messages with a lighter background;
85+
86+
You could also apply your own custom CSS, but keep in mind:
87+
88+
- We don't guarantee the stability of HTML or CSS class names
89+
- Custom overrides might break if we update the rendering engine
90+
91+
The [Embed mode](/help/customization-options/embed-mode/) is an even more advanced way to integrate Bump.sh with your existing doc sites and branding.
92+
93+
We are always open to adding more customization options: if you need to customize other parts of the UI, just [send us a message](mailto:hello@bump.sh) and we'll add the required CSS variables.
94+
5795
## Hub customization
5896

5997
All of these customization settings can be applied to all the documentation within a [hub](/help/hubs/).

src/_help/customization-options/deep-customization-injection-analytics.md

Lines changed: 0 additions & 59 deletions
This file was deleted.
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Head injection (analytics and tools integration)
3+
---
4+
5+
- TOC
6+
{:toc}
7+
8+
`<head>` injection allows you to set up the same set of tools that you have on your own platform, for example, by adding analytics to your Bump.sh documentation or integration support tools such as Intercom, using a script injected in the `<head>` section of your docs.
9+
10+
## How-to
11+
12+
Head injections can be done either through a [reverse proxy](/help/customization-options/embed-mode/#configure-your-proxy) you've set up or managed by Bump.sh. Feel free to [contact us](mailto:hello@bump.sh) so we can assist you.
13+
14+
The `<head>` section is the place to do it. It supports any attribute that can be added in a `<head>` section: metadata, scripts, stylesheets, fonts, ...
15+
16+
```
17+
<!-- Bump.sh: head start -->
18+
<meta name="custom-head" />
19+
<!-- Bump.sh: head end -->
20+
```
21+
22+

src/_help/customization-options/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ title: Customization options
77

88
Bump.sh offers several customization options for your documentation and hubs to provide a tailored and unique experience for your API consumers.
99

10-
[Custom Domains](/help/customization-options/custom-domains/) allow you to replace Bump.sh's domain in URLs with your own, making it easier to access your documentation. You can also customize the color, [logo and social media image](/help/customization-options/color-logo-meta-images/) to maintain your brand's visibility.
10+
[Custom Domains](/help/customization-options/custom-domains/) allow you to replace Bump.sh's domain in URLs with your own, making it easier to access your documentation. You can also customize the [color, logo and social media image](/help/customization-options/color-logo-meta-images/) to maintain your brand's visibility.
1111

1212
Finally, you can define the method for [sorting API operations](/help/customization-options/operations-navigation/) to offer a comfortable and smooth reading experience.
1313

14-
> Some customization options, such as [Embed mode](/help/customization-options/embed-mode/) or [custom CSS & head injection](/help/customization-options/deep-customization-injection-analytics/) (for analytics for instance), depend on the plan you have subscribed to. Feel free to [contact us](mailto:hello@bump.sh) if you’d like to take advantage of a specific feature.
15-
{: .info}
14+
> Some customization options, such as [Embed mode](/help/customization-options/embed-mode/) [advanced style customization](/help/customization-options/color-logo-meta-images/#advanced-customization-through-css-variables), or [head injection](/help/customization-options/head-injection-analytics-tools-integration/) (for analytics and tools integration) depend on the plan you have subscribed to. Feel free to [contact us](mailto:hello@bump.sh) if you’d like to take advantage of a specific feature.
15+
{: .info}
16+

src/_help/hubs/customize-ui.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,9 @@ By default, we apply filters to make your light mode color and logo blend in dar
2222

2323
![Dark mode settings](/images/help/dark-mode-settings.png)
2424

25+
## Advanced customization through CSS variables
26+
The [advanced customization settings](/help/customization-options/color-logo-meta-images/#advanced-customization-through-css-variables) available for documentation can also be applied to all the documentation within a hub.
27+
2528
## Operations sorting
2629

2730
Finally, you can choose to apply a general sorting parameter to all the documentations in your hub with the Group by operations (by path or tag) and Navigation options.

0 commit comments

Comments
 (0)