|
1 | 1 | --- |
2 | | -title: Color, logo and social media image |
| 2 | +title: Branding customization |
3 | 3 | --- |
4 | 4 |
|
5 | 5 | - TOC |
@@ -54,6 +54,44 @@ It is advisable not to exceed a width of 1200px and to maintain the height betwe |
54 | 54 |
|
55 | 55 |  |
56 | 56 |
|
| 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 | + |
57 | 95 | ## Hub customization |
58 | 96 |
|
59 | 97 | All of these customization settings can be applied to all the documentation within a [hub](/help/hubs/). |
|
0 commit comments