From ffb2a90f7e3af7260be9854d90a3f274a34d08c3 Mon Sep 17 00:00:00 2001 From: Aaron Siddhartha Mondal Date: Fri, 5 Jul 2024 08:28:53 +0200 Subject: [PATCH] Readme update fixed (#39) * Reorder `README` (#1077) * Reorder `README` and added the repobeats project. * Update README.md * Improve README branding and links (#1074) * Revert "Improve README branding and links (#1074)" (#1080) This reverts commit 1f107e4666a8bc046ea5356008450f7d83ef77a8. * Improve README branding and links --------- Co-authored-by: Marcus Eagan Co-authored-by: Blake Hatch --- README.md | 25 ++++++++++++++++++++----- docs/scripts/md_to_mdx.ts | 7 ++++++- 2 files changed, 26 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index adbdd868c5..7a953842d2 100644 --- 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) +# +

+ + + + + NativeLink + + +

+ +[![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 index 640c621c4b..0558b9c6ee 100644 --- 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, ">")); + const htmlTagPattern = /^[<\s][^>]*>/g; + if (htmlTagPattern.test(line)) { + processedLines.push(line); + } else { + processedLines.push(line.replace(//g, ">")); + } } return processedLines.join("\n");