From 6cf920a59ee026953bc921999dd7c0e679d1f5cc Mon Sep 17 00:00:00 2001 From: Milo Schwartz Date: Sat, 25 Jan 2025 13:37:35 -0500 Subject: [PATCH] fix code block formatting in components --- .../docs/02-Getting Started/03-quick-install.md | 4 +--- .../04-Manual Install Guides/01-docker-compose.md | 9 ++------- .../docs/02-Getting Started/06-how-to-update.md | 5 +---- .../docs/03-Pangolin/03-without-tunneling.md | 5 +---- packages/docusaurus/docs/06-Newt/02-install.md | 4 +--- packages/docusaurus/src/components/DockerCompose.tsx | 3 ++- .../docusaurus/src/components/StaticTraefikConfig.tsx | 10 +++++++--- .../docusaurus/src/components/UpdatingVersionsYaml.tsx | 3 ++- .../docusaurus/src/components/WgetNewtInstaller.tsx | 3 ++- .../docusaurus/src/components/WgetQuickInstaller.tsx | 3 ++- .../src/components/WithoutTunnelingCompose.tsx | 3 ++- 11 files changed, 23 insertions(+), 29 deletions(-) diff --git a/packages/docusaurus/docs/02-Getting Started/03-quick-install.md b/packages/docusaurus/docs/02-Getting Started/03-quick-install.md index 56e9811..10dc6b3 100644 --- a/packages/docusaurus/docs/02-Getting Started/03-quick-install.md +++ b/packages/docusaurus/docs/02-Getting Started/03-quick-install.md @@ -24,9 +24,7 @@ Installer binaries for Linux can be found in the [Github releases](https://githu For example, on `amd64` download the installer with either wget or curl and make it executable: - - - + The downloaded files will be named `installer` in the current directory. diff --git a/packages/docusaurus/docs/02-Getting Started/04-Manual Install Guides/01-docker-compose.md b/packages/docusaurus/docs/02-Getting Started/04-Manual Install Guides/01-docker-compose.md index d77ca16..b31cecd 100644 --- a/packages/docusaurus/docs/02-Getting Started/04-Manual Install Guides/01-docker-compose.md +++ b/packages/docusaurus/docs/02-Getting Started/04-Manual Install Guides/01-docker-compose.md @@ -1,4 +1,3 @@ -import CodeBlock from '@theme/CodeBlock'; import DockerCompose from "@site/src/components/DockerCompose"; import StaticTraefikConfig from "@site/src/components/StaticTraefikConfig"; @@ -60,17 +59,13 @@ _For any Traefik configuration changes beyond what is needed in this tutorial, p ## Docker Compose File - - - + ## Traefik Configuration `config/traefik/traefik_config.yml` - - - + `config/traefik/dynamic_config.yml` diff --git a/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md b/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md index aeef69c..197160c 100644 --- a/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md +++ b/packages/docusaurus/docs/02-Getting Started/06-how-to-update.md @@ -1,4 +1,3 @@ -import CodeBlock from '@theme/CodeBlock'; import UpdatingVersionsYaml from "@site/src/components/UpdatingVersionsYaml"; # Updating Versions @@ -15,9 +14,7 @@ sudo docker compose down 2. Update the docker compose file with the new version number - - - + Do this for each container you want to update. diff --git a/packages/docusaurus/docs/03-Pangolin/03-without-tunneling.md b/packages/docusaurus/docs/03-Pangolin/03-without-tunneling.md index 8e5bec7..42c1c16 100644 --- a/packages/docusaurus/docs/03-Pangolin/03-without-tunneling.md +++ b/packages/docusaurus/docs/03-Pangolin/03-without-tunneling.md @@ -1,4 +1,3 @@ -import CodeBlock from '@theme/CodeBlock'; import WithoutTunnelingCompose from "@site/src/components/WithoutTunnelingCompose"; # Without Tunneling @@ -19,9 +18,7 @@ When asked if you want to install Gerbil for tunneling, select no. Gerbil will b Follow existing manual install steps, but Gerbil is not required. Your Docker compose should look like the below. - - - + After first starting the app, make sure to fill out all of your information, like `dashboard_url`, `base_domain`, etc the `config.yml` that was generated for you in the volume. diff --git a/packages/docusaurus/docs/06-Newt/02-install.md b/packages/docusaurus/docs/06-Newt/02-install.md index 0936760..31b9ec6 100644 --- a/packages/docusaurus/docs/06-Newt/02-install.md +++ b/packages/docusaurus/docs/06-Newt/02-install.md @@ -17,9 +17,7 @@ On Linux for example: Download Newt with either wget or curl or from your browser and make it executable: - - - + And run it: diff --git a/packages/docusaurus/src/components/DockerCompose.tsx b/packages/docusaurus/src/components/DockerCompose.tsx index 52426ec..c06febd 100644 --- a/packages/docusaurus/src/components/DockerCompose.tsx +++ b/packages/docusaurus/src/components/DockerCompose.tsx @@ -1,3 +1,4 @@ +import CodeBlock from "@theme/CodeBlock"; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -62,7 +63,7 @@ const DockerCompose: React.FC = () => { })(); }, []); - return <>{text}; + return {text}; }; export default DockerCompose; diff --git a/packages/docusaurus/src/components/StaticTraefikConfig.tsx b/packages/docusaurus/src/components/StaticTraefikConfig.tsx index 6658d4f..ab6cf57 100644 --- a/packages/docusaurus/src/components/StaticTraefikConfig.tsx +++ b/packages/docusaurus/src/components/StaticTraefikConfig.tsx @@ -1,3 +1,4 @@ +import CodeBlock from '@theme/CodeBlock'; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -48,12 +49,15 @@ entryPoints: certResolver: "letsencrypt" serversTransport: - insecureSkipVerify: true -`); + insecureSkipVerify: true`); })(); }, []); - return <>{text}; + return ( + + {text} + + ); }; export default StaticTraefikConfig; diff --git a/packages/docusaurus/src/components/UpdatingVersionsYaml.tsx b/packages/docusaurus/src/components/UpdatingVersionsYaml.tsx index fb72f18..b68f69c 100644 --- a/packages/docusaurus/src/components/UpdatingVersionsYaml.tsx +++ b/packages/docusaurus/src/components/UpdatingVersionsYaml.tsx @@ -1,3 +1,4 @@ +import CodeBlock from "@theme/CodeBlock"; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -17,7 +18,7 @@ const UpdatingVersionsYaml: React.FC = () => { })(); }, []); - return <>{text}; + return {text}; }; export default UpdatingVersionsYaml; diff --git a/packages/docusaurus/src/components/WgetNewtInstaller.tsx b/packages/docusaurus/src/components/WgetNewtInstaller.tsx index dbaa28c..dbbc756 100644 --- a/packages/docusaurus/src/components/WgetNewtInstaller.tsx +++ b/packages/docusaurus/src/components/WgetNewtInstaller.tsx @@ -1,3 +1,4 @@ +import CodeBlock from "@theme/CodeBlock"; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -14,7 +15,7 @@ const WgetNewtInstaller: React.FC = () => { })(); }, []); - return <>{text}; + return {text}; }; export default WgetNewtInstaller; diff --git a/packages/docusaurus/src/components/WgetQuickInstaller.tsx b/packages/docusaurus/src/components/WgetQuickInstaller.tsx index d906fed..fff4263 100644 --- a/packages/docusaurus/src/components/WgetQuickInstaller.tsx +++ b/packages/docusaurus/src/components/WgetQuickInstaller.tsx @@ -1,3 +1,4 @@ +import CodeBlock from "@theme/CodeBlock"; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -13,7 +14,7 @@ const WgetQuickInstall: React.FC = () => { })(); }, []); - return <>{text}; + return {text}; }; export default WgetQuickInstall; diff --git a/packages/docusaurus/src/components/WithoutTunnelingCompose.tsx b/packages/docusaurus/src/components/WithoutTunnelingCompose.tsx index 12933cc..9df5f93 100644 --- a/packages/docusaurus/src/components/WithoutTunnelingCompose.tsx +++ b/packages/docusaurus/src/components/WithoutTunnelingCompose.tsx @@ -1,3 +1,4 @@ +import CodeBlock from "@theme/CodeBlock"; import React, { useEffect, useState } from "react"; import { fetchLatestRelease } from "../lib/fetchLatestRelease"; @@ -40,7 +41,7 @@ const WithoutTunnelingCompose: React.FC = () => { })(); }, []); - return <>{text}; + return {text}; }; export default WithoutTunnelingCompose;