Merge pull request #57 from terrastruct/update

Sept 3 update

Author: alixander

README.md

@@ -46,7 +46,13 @@ catalog we've found is
 
 ### Run locally
 
-`yarn && yarn dev`
+```sh
+# Only needed first run
+git submodule update --init --recursive
+yarn
+
+yarn dev
+```
 
 ### Adding examples
 
@@ -61,6 +67,11 @@ Please follow the examples in `src/examples`.
 1. Create the text for as many languages as you can. It's okay if not totally complete. We
 or others can fill.
 1. Run `./render.sh` (with the respective tools installed)
+  - Pre-requisite tools:
+    - `mmdc`
+    - `plantuml`
+    - `graphviz`
+    - `d2`
 
 <img alt="CLI render" src="/docs/assets/render.png" />
 

src/components/CodeBlock.tsx

@@ -150,7 +150,6 @@ async function newTextMateRegistry() {
           return parseRawGrammar(markdownGrammar);
       }
 
-      console.warn(`unknown scope name: ${scope}`);
       return undefined;
     },
   });

src/components/Features.tsx

@@ -144,7 +144,7 @@ const features: Feature[] = [
       [D2_LANG]: 'Any URL',
       [MERMAID_LANG]: 'FontAwesome. Hacky <img> tags',
       [GRAPHVIZ_LANG]: false,
-      [PLANTUML_LANG]: false,
+      [PLANTUML_LANG]: 'Any URL',
     },
   },
   {
@@ -194,7 +194,7 @@ const features: Feature[] = [
       [D2_LANG]: true,
       [MERMAID_LANG]: false,
       [GRAPHVIZ_LANG]: false,
-      [PLANTUML_LANG]: false,
+      [PLANTUML_LANG]: true,
     },
   },
   {
@@ -246,7 +246,7 @@ const features: Feature[] = [
       [D2_LANG]: true,
       [MERMAID_LANG]: false,
       [GRAPHVIZ_LANG]: true,
-      [PLANTUML_LANG]: false,
+      [PLANTUML_LANG]: 'With additional installs',
     },
   },
 ];

src/components/faq.tsx

@@ -37,15 +37,15 @@ const items = [
   },
   {
     question: 'How up-to-date is this?',
-    answer: `Very up to date. Every so often, we upgrade to latest version of all tools and regenerate all. Latest: July 31, 2023.`,
+    answer: `Very up to date. Every so often, we upgrade to latest version of all tools and regenerate all. Latest: September 03, 2024.`,
   },
   {
     question: 'Who made this?',
     answer: `This is created and maintained by Terrastruct. We created D2, and it's in our interest to provide anyone evaluating us with an objective comparison against others in the space. The only favor granted to D2 is that it shows up as the first comparison. We welcome contributions, and if any examples potentially make D2 look bad, we will include them without bias (and then furiously improve D2 so the example looks better, a right other tools have as well).`,
   },
   {
     question: "Why isn't [my favorite underground language] here?",
-    answer: `The cross-table of examples and languages is big, and nobody's gotten around to it yet. We're seeding and adding languages in order of perceived popularity. If you'd like to help support your favorite one, feel free to submit a PR -- we'll merge.`,
+    answer: `The cross-table of examples and languages is big, and nobody's gotten around to it yet. We're seeding and adding languages in order of perceived popularity. If you'd like to help support your favorite one, feel free to submit a PR -- we'll merge. Note that if the language is niche, like only does network diagrams, it's useless comparing to other languages so will be out of scope for this site.`,
   },
   {
     question: 'Future plans?',