Skip to content

Commit 352bf4a

Browse files
committed
docs: update README with new settings
1 parent c4236fc commit 352bf4a

1 file changed

Lines changed: 10 additions & 7 deletions

File tree

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -58,16 +58,18 @@ extensions:
5858
auto-filename: true
5959
style: "macos"
6060
wrapper: "code-window"
61+
skylighting-fix: true
6162
```
6263

6364
### Options
6465

65-
| Option | Type | Default | Description |
66-
| --------------- | ------- | --------------- | -------------------------------------------------------------------- |
67-
| `enabled` | boolean | `true` | Enable or disable the code-window filter. |
68-
| `auto-filename` | boolean | `true` | Automatically generate filename labels from the code block language. |
69-
| `style` | string | `"macos"` | Window decoration style: `"macos"`, `"windows"`, or `"default"`. |
70-
| `wrapper` | string | `"code-window"` | Typst wrapper function name for code-window rendering. |
66+
| Option | Type | Default | Description |
67+
| ----------------- | ------- | --------------- | ----------------------------------------------------------------------------------- |
68+
| `enabled` | boolean | `true` | Enable or disable the code-window filter. |
69+
| `auto-filename` | boolean | `true` | Automatically generate filename labels from the code block language. |
70+
| `style` | string | `"macos"` | Window decoration style: `"macos"`, `"windows"`, or `"default"`. |
71+
| `wrapper` | string | `"code-window"` | Typst wrapper function name for code-window rendering. |
72+
| `skylighting-fix` | boolean | `true` | Enable or disable the Skylighting hot-fix for Typst output (block and inline code). |
7173

7274
### Styles
7375

@@ -88,8 +90,9 @@ print("Windows style for this block only")
8890
### Typst Skylighting Hot-fix (Integrated)
8991

9092
`code-window` loads its Typst skylighting hot-fix internally from `_extensions/code-window/skylighting-typst-fix.lua`, so no second filter entry is required.
93+
Set `skylighting-fix: false` to disable the hot-fix without removing the file.
9194

92-
This keeps the hot-fix separated from `code-window.lua` for easy future removal while preserving combined behavior.
95+
This keeps the hot-fix separated from `code-window.lua` for easy future removal while preserving combined behaviour.
9396

9497
Future removal playbook:
9598

0 commit comments

Comments
 (0)