Skip to content

Commit fa13190

Browse files
committed
apply formatting for code block names, reduce variations
1 parent affe2f7 commit fa13190

17 files changed

Lines changed: 45 additions & 19 deletions

File tree

docs/debugging-native-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ adb logcat "*:S" ReactNative:V ReactNativeJS:V YourModuleName:D
5050

5151
In your native module, use `NSLog` for custom logs:
5252

53-
```objective-c
53+
```objectivec
5454
NSLog(@"YourModuleName: %@", message);
5555
```
5656

plugins/remark-codeblock-language-as-title/src/index.ts

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,18 +7,44 @@
77

88
import {Root} from 'mdast';
99

10+
const LANGUAGES_MAP: Record<string, string> = {
11+
js: 'JavaScript',
12+
javascript: 'JavaScript',
13+
ts: 'TypeScript',
14+
typescript: 'TypeScript',
15+
jsx: 'React JSX',
16+
tsx: 'React TSX',
17+
json: 'JSON',
18+
objc: 'Objective-C',
19+
objectivec: 'Objective-C',
20+
xml: 'XML',
21+
css: 'CSS',
22+
cpp: 'C++',
23+
};
24+
25+
const HIDDEN_TITLES = ['zsh', 'sh', 'shell', 'bash', 'powershell'];
26+
27+
function capitalizeFirstLetter(str: string | null) {
28+
if (!str) {
29+
return str;
30+
}
31+
return str[0].toUpperCase() + str.slice(1);
32+
}
33+
1034
export default function codeblockLanguageAsTitleRemarkPlugin() {
1135
return async (root: Root) => {
1236
const {visit} = await import('unist-util-visit');
1337
visit(root, 'code', node => {
14-
if (node.lang && !['shell', 'bash'].includes(node.lang)) {
38+
if (node.lang && !HIDDEN_TITLES.includes(node.lang)) {
39+
const formattedTitle =
40+
LANGUAGES_MAP[node.lang] ?? capitalizeFirstLetter(node.lang);
1541
if (node.meta) {
1642
if (node.meta.includes('title=')) {
1743
return;
1844
}
19-
node.meta = `title="${node.lang}" ${node.meta}`;
45+
node.meta = `title="${formattedTitle}" ${node.meta}`;
2046
} else {
21-
node.meta = `title="${node.lang}"`;
47+
node.meta = `title="${formattedTitle}"`;
2248
}
2349
}
2450
});

website/versioned_docs/version-0.77/debugging-native-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ adb logcat "*:S" ReactNative:V ReactNativeJS:V YourModuleName:D
5050

5151
In your native module, use `NSLog` for custom logs:
5252

53-
```objective-c
53+
```objectivec
5454
NSLog(@"YourModuleName: %@", message);
5555
```
5656

website/versioned_docs/version-0.77/the-new-architecture/custom-cxx-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Now, we need to implement the `validateAddress` function in C++. First, we need
336336
337337
2. Open the `shared/NativeSampleModule.cpp` file and add the function implementation
338338
339-
```c++ title="NativeSampleModule.cpp (validateAddress implementation)"
339+
```cpp title="NativeSampleModule.cpp (validateAddress implementation)"
340340
bool NativeSampleModule::validateAddress(jsi::Runtime &rt, jsi::Object input) {
341341
std::string street = input.getProperty(rt, "street").asString(rt).utf8(rt);
342342
int32_t number = input.getProperty(rt, "num").asNumber();

website/versioned_docs/version-0.78/debugging-native-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ adb logcat "*:S" ReactNative:V ReactNativeJS:V YourModuleName:D
5050

5151
In your native module, use `NSLog` for custom logs:
5252

53-
```objective-c
53+
```objectivec
5454
NSLog(@"YourModuleName: %@", message);
5555
```
5656

website/versioned_docs/version-0.78/the-new-architecture/custom-cxx-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Now, we need to implement the `validateAddress` function in C++. First, we need
336336
337337
2. Open the `shared/NativeSampleModule.cpp` file and add the function implementation
338338
339-
```c++ title="NativeSampleModule.cpp (validateAddress implementation)"
339+
```cpp title="NativeSampleModule.cpp (validateAddress implementation)"
340340
bool NativeSampleModule::validateAddress(jsi::Runtime &rt, jsi::Object input) {
341341
std::string street = input.getProperty(rt, "street").asString(rt).utf8(rt);
342342
int32_t number = input.getProperty(rt, "num").asNumber();

website/versioned_docs/version-0.79/debugging-native-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ adb logcat "*:S" ReactNative:V ReactNativeJS:V YourModuleName:D
5050

5151
In your native module, use `NSLog` for custom logs:
5252

53-
```objective-c
53+
```objectivec
5454
NSLog(@"YourModuleName: %@", message);
5555
```
5656

website/versioned_docs/version-0.79/the-new-architecture/custom-cxx-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Now, we need to implement the `validateAddress` function in C++. First, we need
336336
337337
2. Open the `shared/NativeSampleModule.cpp` file and add the function implementation
338338
339-
```c++ title="NativeSampleModule.cpp (validateAddress implementation)"
339+
```cpp title="NativeSampleModule.cpp (validateAddress implementation)"
340340
bool NativeSampleModule::validateAddress(jsi::Runtime &rt, jsi::Object input) {
341341
std::string street = input.getProperty(rt, "street").asString(rt).utf8(rt);
342342
int32_t number = input.getProperty(rt, "num").asNumber();

website/versioned_docs/version-0.80/debugging-native-code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ adb logcat "*:S" ReactNative:V ReactNativeJS:V YourModuleName:D
5050

5151
In your native module, use `NSLog` for custom logs:
5252

53-
```objective-c
53+
```objectivec
5454
NSLog(@"YourModuleName: %@", message);
5555
```
5656

website/versioned_docs/version-0.80/the-new-architecture/custom-cxx-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,7 +336,7 @@ Now, we need to implement the `validateAddress` function in C++. First, we need
336336
337337
2. Open the `shared/NativeSampleModule.cpp` file and add the function implementation
338338
339-
```c++ title="NativeSampleModule.cpp (validateAddress implementation)"
339+
```cpp title="NativeSampleModule.cpp (validateAddress implementation)"
340340
bool NativeSampleModule::validateAddress(jsi::Runtime &rt, jsi::Object input) {
341341
std::string street = input.getProperty(rt, "street").asString(rt).utf8(rt);
342342
int32_t number = input.getProperty(rt, "num").asNumber();

0 commit comments

Comments
 (0)