Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Readme update fixed #39

Merged
merged 5 commits into from
Jul 5, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 20 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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

Expand Down
7 changes: 6 additions & 1 deletion docs/scripts/md_to_mdx.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
Loading