@@ -22,7 +22,7 @@ the Palette CLI `docs` command [page](../automation/palette-cli/commands/docs.md
2222
2323:::
2424
25- ## Limitations
25+ ### Limitations
2626
2727The following limitations apply when using the offline documentation:
2828
@@ -32,7 +32,7 @@ The following limitations apply when using the offline documentation:
3232
3333- The documentation AI helper is not available.
3434
35- ## Prerequisites
35+ ### Prerequisites
3636
3737The following software must be installed on your system:
3838
@@ -102,42 +102,6 @@ The following software must be installed on your system:
102102docker run --publish 8080:80 --publish 2019:2019 --rm ghcr.io/spectrocloud/librarium:nightly
103103```
104104
105- ## Deploy the Offline Documentation with Custom Logos
106-
107- You can provide your own custom logos to the Spectro Cloud documentation.
108-
109- ::: info
110-
111- We recommend that you provide two logos, one for dark mode and one for light mode. The files must be in PNG format.
112-
113- :::
114-
115- 1 . Download the logos you want to configure to your local machine.
116-
117- 2 . Replace the placeholders in the following command with the path to your logo files. Then, execute the command in your
118- terminal to save the location of the files to two environment variables.
119-
120- ``` shell
121- export LIGHT_LOGO_PATH=path/to/light/custom/logo/file \
122- export DARK_LOGO_PATH=path/to/dark/custom/logo/file
123- ```
124-
125- 3 . Use the following command to start the documentation in a Docker container.
126-
127- ``` shell
128- docker run \
129- --env LIGHT_LOGO_PATH=$LIGHT_LOGO_PATH \
130- --env DARK_LOGO_PATH=$DARK_LOGO_PATH \
131- --volume " $( realpath " $LIGHT_LOGO_PATH " ) " :/librarium/static/img/custom-light-logo.png \
132- --volume " $( realpath " $DARK_LOGO_PATH " ) " :/librarium/static/img/custom-dark-logo.png \
133- --publish 8080:80 \
134- --publish 2019:2019 \
135- --rm ghcr.io/spectrocloud/librarium:nightly
136- ```
137-
138- 4 . Open a browser and navigate to ` http://localhost:8080 ` to view the documentation. The navigation bar displays your
139- custom configured logo.
140-
141105## Validation
142106
143107To validate that the offline documentation is working, open a browser and navigate to ` http://localhost:8080 ` . The
0 commit comments