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

docs: Fix code block styling #5058

Merged
merged 3 commits into from
May 21, 2024
Merged

docs: Fix code block styling #5058

merged 3 commits into from
May 21, 2024

Conversation

jamilbk
Copy link
Member

@jamilbk jamilbk commented May 21, 2024

Fixes the styling bug that occurs when we use triple backticks to define code blocks in markdown.

Now it looks like this:

Screenshot 2024-05-20 at 10 55 56 PM

NOTE

You must specify a language to use for highlighting, or text if plaintext. Otherwise, no codeblock colorizing will occur.

Fixes #5057

Copy link

vercel bot commented May 21, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
firezone ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 21, 2024 2:43pm

@github-actions github-actions bot added the kind/docs Improvements or updates to documentation label May 21, 2024
Copy link

github-actions bot commented May 21, 2024

Terraform Cloud Plan Output

Plan: 15 to add, 15 to change, 15 to destroy.

Terraform Cloud Plan

Copy link

github-actions bot commented May 21, 2024

Performance Test Results

TCP

Test Name Received/s Sent/s Retransmits
direct-tcp-client2server 240.2 MiB (-1%) 241.7 MiB (-1%) 197 (-38%)
direct-tcp-server2client 240.0 MiB (-1%) 241.5 MiB (-1%) 318 (+36%)
relayed-tcp-client2server 228.2 MiB (+0%) 229.0 MiB (+0%) 261 (+9%)
relayed-tcp-server2client 237.2 MiB (+1%) 237.8 MiB (+1%) 319 (-30%)

UDP

Test Name Total/s Jitter Lost
direct-udp-client2server 500.0 MiB (-0%) 0.04ms (-84%) 37.83% (+1%)
direct-udp-server2client 500.0 MiB (+0%) 0.01ms (-44%) 21.16% (-2%)
relayed-udp-client2server 500.0 MiB (+0%) 0.03ms (-93%) 54.48% (-5%)
relayed-udp-server2client 500.0 MiB (+0%) 0.02ms (+70%) 41.50% (-4%)

@ReactorScram
Copy link
Collaborator

ReactorScram commented May 21, 2024

Side-by-side view

Before:
image

After:
image

That does look nicer. Much better contrast, too.

Copy link
Collaborator

@ReactorScram ReactorScram left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@@ -385,7 +385,8 @@ works the same for any third-party SaaS service.

1. An admin defines a DNS Resource with address `*.slack.com` in the Firezone
admin portal. Notice the wildcard -- this will route all subdomains for Slack
through Firezone as well, which helps ensure all relevant Slack traffic is routed.
through Firezone as well, which helps ensure all relevant Slack traffic is
routed.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a hard word wrap I should set in my editors?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So I use prettier set at 80, but it's not a hard requirement. Wrapping markdown is handled to varying degrees of success depending on the editor.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would just like to avoid like 200 line markdown paragraphs if possible.

website/tailwind.config.js Show resolved Hide resolved
@@ -370,7 +369,7 @@ export default function Page() {
</ChromeIcon>
</div>
<div className="p-4 flex items-center justify-center bg-white rounded-lg border border-2 border-neutral-200">
<AppleIcon size={12} href="/kb/user-guides/macos-client">
<AppleIcon size={12} href="/kb/user-guides/ios-client">
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess the Apple Clients used to share one page and then they split into macOS and iOS? the iOS link was still pointed to macOS so I fixed that.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

They both still say "Apple Clients" though

@jamilbk jamilbk enabled auto-merge May 21, 2024 15:25
@jamilbk jamilbk added this pull request to the merge queue May 21, 2024
Merged via the queue into main with commit 37ed0c8 May 21, 2024
135 checks passed
@jamilbk jamilbk deleted the fix/code-styling branch May 21, 2024 17:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/docs Improvements or updates to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Fix code highlighting for React MDX
2 participants