Skip to content

Commit 1b7355d

Browse files
authored
[Style Guide] Interlink between code block guidance (cloudflare#25149)
1 parent db8a3cb commit 1b7355d

File tree

3 files changed

+9
-1
lines changed

3 files changed

+9
-1
lines changed

src/content/docs/style-guide/components/code.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,9 @@ styleGuide:
55
---
66

77
Code blocks are powered by [Expressive Code](https://expressive-code.com/), a project by Astro.
8-
This is just a small showcase of functionality, it has a lot of options!
8+
This is just a small showcase of the wide functionality of this component.
9+
10+
Learn more about formatting in the [code block formatting guide](/style-guide/formatting/code-conventions-and-format/).
911

1012
````mdx live
1113
```powershell title="PowerShell"

src/content/docs/style-guide/formatting/code-block-guidelines.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ To define the syntax highlighting language used for the code block, enter a lang
1212

1313
Use the `txt` language when there is no appropriate syntax highlighting (for example, a fragment of an Apache configuration file).
1414

15+
Learn more about what you can do with code blocks in the [code block component guide](/style-guide/components/code/).
16+
1517
## JSON example
1618

1719
````

src/content/docs/style-guide/formatting/code-conventions-and-format.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ title: Code conventions and format
66

77
Use the conventions described below throughout Cloudflare product content.
88

9+
[Learn about code block formatting guidelines](/style-guide/formatting/code-block-guidelines/).
10+
11+
[Learn about the code block component](/style-guide/components/code/).
12+
913
## Angle brackets ( `<` and `>` )
1014

1115
Use angle brackets to denote placeholders for variables you want the user to enter (except in [API URLs and API authentication headers](/style-guide/api-content-strategy/guidelines-for-curl-commands/#request-guidelines), where you should use the `$ZONE_ID` / `$CLOUDFLARE_API_TOKEN` format). Placeholder text should have all capital letters and use underscores (`_`) to separate words.

0 commit comments

Comments
 (0)