Readme update fixed (#39)

* Reorder `README` (TraceMachina#1077) * Reorder `README` and added the repobeats project. * Update README.md * Improve README branding and links (TraceMachina#1074) * Revert "Improve README branding and links (TraceMachina#1074)" (TraceMachina#1080) This reverts commit 1f107e4. * Improve README branding and links --------- Co-authored-by: Marcus Eagan <[email protected]> Co-authored-by: Blake Hatch <[email protected]>
aaronmondal · Jul 5, 2024 · ffb2a90 · ffb2a90
1 parent f5e7276
commit ffb2a90
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 6 deletions.
diff --git a/README.md b/README.md
@@ -1,9 +1,20 @@
-# NativeLink
-
-[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+#
+<p align="center">
+  <a href="https://www.nativelink.com">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/tracemachina/nativelink/main/docs/src/assets/logo-dark.svg"/>
+      <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/tracemachina/nativelink/main/docs/src/assets/logo-light.svg"/>
+      <img alt="NativeLink" src="https://raw.githubusercontent.com/tracemachina/nativelink/main/docs/src/assets/logo-light.svg"/>
+    </picture>
+  </a>
+</p>
+
+[![Homepage](https://img.shields.io/badge/Homepage-8A2BE2)](https://nativelink.com)
+[![GitHub stars](https://img.shields.io/github/stars/tracemachina/nativelink?style=social)](https://github.com/TraceMachina/nativelink)
 [![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/TraceMachina/nativelink/badge)](https://securityscorecards.dev/viewer/?uri=github.com/TraceMachina/nativelink)
 [![OpenSSF Best Practices](https://www.bestpractices.dev/projects/8050/badge)](https://www.bestpractices.dev/projects/8050)
 [![Slack](https://img.shields.io/badge/slack--channel-blue?logo=slack)](https://nativelink.slack.com/join/shared_invite/zt-281qk1ho0-krT7HfTUIYfQMdwflRuq7A#/shared-invite/email)
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
 
 NativeLink is an extremely (blazingly?) fast and efficient build cache and
 remote executor for systems that communicate using the [Remote execution
@@ -16,6 +27,10 @@ Supports Unix-based operating systems and Windows.
 
 Below, you will find a few different options for getting started with NativeLink.
 
+## 🚀 Example Deployments
+
+You can find a few example deployments in the [deployment-examples directory](./deployment-examples).
+
 ### 📝 Clone the NativeLink repository
 1. Go to the [NativeLink](https://github.com/TraceMachina/nativelink) repository on GitHub. Clone the repository via SSH or HTTPS. In this example the repository is cloned via SSH:
 ```bash
@@ -192,9 +207,9 @@ cargo run --release --bin nativelink -- ./nativelink-config/examples/basic_cas.j
 > cargo clean
 > ```
 
-## 🚀 Example Deployments
+## Project Health
 
-You can find a few example deployments in the [deployment-examples directory](./deployment-examples).
+* Powering more than 1 billion devices at the edge.
 
 ## 🏺 History
 

diff --git a/docs/scripts/md_to_mdx.ts b/docs/scripts/md_to_mdx.ts
@@ -198,7 +198,12 @@ export function preProcessMarkdown(markdown: string): string {
       continue;
     }
 
-    processedLines.push(line.replace(/</g, "&lt;").replace(/>/g, "&gt;"));
+    const htmlTagPattern = /^[<\s][^>]*>/g;
+    if (htmlTagPattern.test(line)) {
+      processedLines.push(line);
+    } else {
+      processedLines.push(line.replace(/</g, "&lt;").replace(/>/g, "&gt;"));
+    }
   }
 
   return processedLines.join("\n");