Skip to content

Commit 8c30ab9

Browse files
authored
Revert "docs: allow custom logos in Docs DOC-1886 DOC-1893 (#6966)" (#6983)
This reverts commit 296b389.
1 parent 296b389 commit 8c30ab9

File tree

4 files changed

+7
-107
lines changed

4 files changed

+7
-107
lines changed

Makefile

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -230,7 +230,8 @@ docker-image: ## Build the docker image
230230
docker build -t $(IMAGE) .
231231

232232
docker-start: docker-image ## Build the docker image and start a local development container
233-
IMAGE=$(IMAGE) ./scripts/start-docker.sh
233+
docker run --env-file=.env --rm -it -v $(CURDIR)/docs:/librarium/docs/ -v $(CURDIR)/_partials/:/librarium/_partials/ -p 9000:9000 $(IMAGE)
234+
234235

235236
##@ Writing Checks
236237

@@ -248,7 +249,7 @@ check-writing: ## Run Vale on changed Markdown/MDX files
248249

249250
##@ Formatting Checks
250251

251-
format: ## Apply Prettier formatting to all files.
252+
format: ## Apply Prettier formating to all files.
252253
npm run format
253254

254255
format-check: ## Check if all files are formatted with Prettier.

docs/docs-content/downloads/offline-docs.md

Lines changed: 2 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ the Palette CLI `docs` command [page](../automation/palette-cli/commands/docs.md
2222

2323
:::
2424

25-
## Limitations
25+
### Limitations
2626

2727
The 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

3737
The following software must be installed on your system:
3838

@@ -102,42 +102,6 @@ The following software must be installed on your system:
102102
docker 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

143107
To validate that the offline documentation is working, open a browser and navigate to `http://localhost:8080`. The

docusaurus.config.js

Lines changed: 2 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,24 +10,6 @@ const { pluginPacksAndIntegrationsData } = require("./plugins/packs-integrations
1010
const { pluginImportFontAwesomeIcons } = require("./plugins/font-awesome");
1111
import path from "path";
1212

13-
// Logo paths are hardcoded through Docker mounts or we use the default logos.
14-
function getLightLogoPath() {
15-
if (process.env.LIGHT_LOGO_PATH && process.env.LIGHT_LOGO_PATH.trim() !== "") {
16-
return "img/custom-light-logo.png";
17-
}
18-
19-
return "img/spectrocloud-logo-light.svg?new=true";
20-
}
21-
22-
// Logo paths are hardcoded through Docker mounts or we use the default logos.
23-
function getDarkLogoPath() {
24-
if (process.env.DARK_LOGO_PATH && process.env.DARK_LOGO_PATH.trim() !== "") {
25-
return "img/custom-dark-logo.png";
26-
}
27-
28-
return "img/spectrocloud-logo-dark.svg?new=true";
29-
}
30-
3113
// We will only show the update time if the environment variable is set to true.
3214
function showLastUpdateTime() {
3315
const envValue = process.env.SHOW_LAST_UPDATE_TIME || "";
@@ -372,8 +354,8 @@ const config = {
372354
width: 105,
373355
height: 48,
374356
alt: "Spectro cloud logo",
375-
src: getLightLogoPath(),
376-
srcDark: getDarkLogoPath(),
357+
src: "img/spectrocloud-logo-light.svg?new=true",
358+
srcDark: "img/spectrocloud-logo-dark.svg?new=true",
377359
},
378360
items: [
379361
{

scripts/start-docker.sh

Lines changed: 0 additions & 47 deletions
This file was deleted.

0 commit comments

Comments
 (0)