Skip to content

(docs) Document startLine prop for CodeBlocks #942

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.

Sign up for GitHub

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

Merged
merged 4 commits into from
Sep 24, 2025
Merged

(docs) Document startLine prop for CodeBlocks #942

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
6a53039
document startLine
devalog Sep 23, 2025
6c8f124
make example more concise
devalog Sep 23, 2025
410968f
fix
devalog Sep 23, 2025
2642cac
add more lines to example
devalog Sep 23, 2025
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
81 changes: 77 additions & 4 deletions fern/products/docs/pages/component-library/default-components/code-blocks.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,79 @@ Instead of highlighting lines, you can focus on specific lines by adding a comme
</Tab>
</Tabs>

## Start line

You can control which line appears first in your code block by adding a `startLine` attribute after the language identifier. This is particularly useful for longer code snippets where you want to highlight the main logic while still providing the complete context.

<Tabs>
<Tab title="Example">
```javascript startLine={6}
console.log("Line 1");
console.log("Line 2");
console.log("Line 3");
console.log("Line 4");
console.log("Line 5");
console.log("Line 6");
console.log("Line 7");
console.log("Line 8");
console.log("Line 9");
console.log("Line 10");
console.log("Line 11");
console.log("Line 12");
console.log("Line 13");
console.log("Line 14");
console.log("Line 15");
console.log("Line 16");
console.log("Line 17");
console.log("Line 18");
console.log("Line 19");
console.log("Line 20");
console.log("Line 21");
console.log("Line 22");
console.log("Line 23");
console.log("Line 24");
console.log("Line 25");
console.log("Line 26");
console.log("Line 27");
console.log("Line 28")
```
</Tab>
<Tab title="Markdown">
````markdown
```javascript startLine={6}
console.log("Line 1");
console.log("Line 2");
console.log("Line 3");
console.log("Line 4");
console.log("Line 5");
console.log("Line 6");
console.log("Line 7");
console.log("Line 8");
console.log("Line 9");
console.log("Line 10");
console.log("Line 11");
console.log("Line 12");
console.log("Line 13");
console.log("Line 14");
console.log("Line 15");
console.log("Line 16");
console.log("Line 17");
console.log("Line 18");
console.log("Line 19");
console.log("Line 20");
console.log("Line 21");
console.log("Line 22");
console.log("Line 23");
console.log("Line 24");
console.log("Line 25");
console.log("Line 26");
console.log("Line 27");
console.log("Line 28")
```
````
</Tab>
</Tabs>

## Max height

You can control the max height of the code block by adding
Expand Down Expand Up @@ -232,13 +305,13 @@ To disable scrolling and wrap overflow onto the next line, use the `wordWrap` pr

## Combining props

You can combine the `title`, `highlight`, `focus`, `maxLines`, and `wordWrap`
props to create a code block with a title, highlighted lines,
You can combine the `title`, `highlight`, `focus`, `startLine`, `maxLines`, and `wordWrap`
props to create a code block with a title, highlighted lines, specific starting line,
and a maximum height.

<Tabs>
<Tab title="Example">
```javascript title="Hello, World!" {2-4} maxLines=5
```javascript title="Hello, World!" {6-8} maxLines=5 startLine={4}
console.log("Line 1");
console.log("Line 2");
console.log("Line 3");
Expand All @@ -253,7 +326,7 @@ and a maximum height.
</Tab>
<Tab title = "Markdown">
````markdown maxLines=5
```javascript title="Hello, World!" {2-4} maxLines=5
```javascript title="Hello, World!" {6-8} maxLines=5 startLine={4}
console.log("Line 1");
console.log("Line 2");
console.log("Line 3");
Expand Down