Add constants file (#182)

stellar · Jul 14, 2023 · acaf2d3 · acaf2d3
1 parent 68c96a9
commit acaf2d3
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 39 deletions.
diff --git a/docs/anchoring-assets/anchor-platform/getting_started.mdx b/docs/anchoring-assets/anchor-platform/getting_started.mdx
@@ -12,7 +12,7 @@ The easiest way to install the Anchor Platform is to pull the [docker image][anc
 <CodeExample>
 
 ```bash
-docker pull stellar/anchor-platform:2.0.1
+docker pull stellar/anchor-platform:[platform_version]
 ```
 
 </CodeExample>
@@ -30,7 +30,7 @@ Let's create a minimal compose file to get started.
 version: "3.8"
 services:
   sep-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --sep-server
     ports:
       - "8080:8080"
@@ -39,7 +39,7 @@ services:
     volumes:
       - ./config:/home
   platform-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --platform-server
     ports:
       - "8085:8085"
@@ -210,7 +210,7 @@ A database is only needed if using the Anchor Platform to facilitate transaction
 version: "3.8"
 services:
   sep-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --sep-server
     env_file:
       - ./dev.env
@@ -221,7 +221,7 @@ services:
     depends_on:
       - db
   platform-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --platform-server
     env_file:
       - ./dev.env

diff --git a/docs/anchoring-assets/anchor-platform/sep24/example.mdx b/docs/anchoring-assets/anchor-platform/sep24/example.mdx
@@ -334,7 +334,7 @@ First, let's configure the Anchor Platform to observe the Stellar network for in
 # docker-compose.yml
 ---
 stellar-observer:
-  image: stellar/anchor-platform:2.0.1
+  image: stellar/anchor-platform:[platform_version]
   command: --stellar-observer
   env_file:
     - ./dev.env

diff --git a/docs/anchoring-assets/anchor-platform/sep31/integration.mdx b/docs/anchoring-assets/anchor-platform/sep31/integration.mdx
@@ -29,7 +29,7 @@ version: "3.8"
 
 services:
   sep-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --sep-server
     env_file:
       - ./dev.env
@@ -40,7 +40,7 @@ services:
     depends_on:
       - db
   platform-server:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --platform-server
     env_file:
       - ./dev.env
@@ -193,7 +193,7 @@ The Stellar Observer monitors the Stellar ledger for payments made to your accou
 services:
   ...
   observer:
-    image: stellar/anchor-platform:2.0.1
+    image: stellar/anchor-platform:[platform_version]
     command: --stellar-observer
     env_file:
       - ./dev.env

diff --git a/src/components/CodeExample.js b/src/components/CodeExample.js
@@ -2,32 +2,7 @@ import React from 'react';
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
-
-export const CODE_LANGS = {
-  bash: 'bash',
-  cpp: 'C++',
-  curl: 'cURL',
-  dart: 'Flutter',
-  flutter: 'Flutter',
-  docker: 'Dockerfile',
-  go: 'Go',
-  html: 'html',
-  kotlin: 'Kotlin',
-  kt: 'Kotlin',
-  java: 'Java',
-  javascript: 'JavaScript',
-  js: 'JavaScript',
-  json: 'JSON',
-  json5: 'JSON5',
-  python: 'Python',
-  scss: 'SCSS',
-  sql: 'SQL',
-  toml: 'TOML',
-  ts: 'TypeScript',
-  tsx: 'TSX',
-  typescript: 'TypeScript',
-  yaml: 'YAML',
-};
+import {CODE_LANGS, PLATFORM_VERSION} from "../constants";
 
 export const CodeExample = ({ children }) => (
   // console.log(children),
@@ -39,14 +14,16 @@ export const CodeExample = ({ children }) => (
 
       const [, language] = className.split('-');
 
+      const platformReplace = codeProps.children.replaceAll('[platform_version]', PLATFORM_VERSION)
+
       return (
         <TabItem
           key={language || index}
           value={language || index}
           label={CODE_LANGS[language] || 'Example'}
         >
           <CodeBlock language={language} showLineNumbers>
-            {codeProps.children}
+            {typeof (codeProps.children) === 'string' ? platformReplace : codeProps.children}
           </CodeBlock>
         </TabItem>
       );

diff --git a/src/components/WalletCodeExample.tsx b/src/components/WalletCodeExample.tsx
@@ -4,8 +4,7 @@ import TabItem from '@theme/TabItem';
 import CodeBlock from '@theme/CodeBlock';
 import {getCookie, walletDefaultLang} from "./LanguageSpecific";
 import BrowserOnly from '@docusaurus/BrowserOnly';
-import {CODE_LANGS} from "./CodeExample";
-import {Exception} from "sass";
+import {CODE_LANGS} from "../constants";
 
 // TODO: when TS docs are ready set to false
 const ALLOW_EMPTY_DOCS = true

diff --git a/src/components/WalletGuideWarn.tsx b/src/components/WalletGuideWarn.tsx
@@ -1,8 +1,8 @@
 import React from "react";
 import Admonition from '@theme/Admonition';
 import {LanguageButtons} from "./LanguageButtons";
-import {CODE_LANGS} from "./CodeExample";
 import {LanguageSpecific} from "./LanguageSpecific";
+import {CODE_LANGS} from "../constants";
 
 type WalletGuideWarnProps = {
     WIPLangs?: String[]

diff --git a/src/constants.ts b/src/constants.ts
@@ -0,0 +1,27 @@
+export const PLATFORM_VERSION="2.1.1"
+
+export const CODE_LANGS = {
+    bash: 'bash',
+    cpp: 'C++',
+    curl: 'cURL',
+    dart: 'Flutter',
+    flutter: 'Flutter',
+    docker: 'Dockerfile',
+    go: 'Go',
+    html: 'html',
+    kotlin: 'Kotlin',
+    kt: 'Kotlin',
+    java: 'Java',
+    javascript: 'JavaScript',
+    js: 'JavaScript',
+    json: 'JSON',
+    json5: 'JSON5',
+    python: 'Python',
+    scss: 'SCSS',
+    sql: 'SQL',
+    toml: 'TOML',
+    ts: 'TypeScript',
+    tsx: 'TSX',
+    typescript: 'TypeScript',
+    yaml: 'YAML',
+};