Skip to content

Commit 926d36b

Browse files
committed
Update README
1 parent bad8579 commit 926d36b

File tree

1 file changed

+23
-19
lines changed

1 file changed

+23
-19
lines changed

README.md

Lines changed: 23 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -447,6 +447,7 @@ Line numbers and ranges aren’t the only things you can pass as options on your
447447
The syntax theme used for code blocks.
448448

449449
- **Default:** `'Default Dark+'`
450+
450451
- **Accepted types**:
451452
- **`string`:** The name or id of a theme. (See [Built-in themes](#themes) and [Using languages and themes from an extension](#using-languages-and-themes-from-an-extension).)
452453
- **`ThemeSettings`:** An object that selects different themes to use in different contexts. (See [Multi-theme support](#multi-theme-support).)
@@ -467,29 +468,32 @@ A custom class name to be set on the `pre` tag.
467468

468469
### `languageAliases`
469470

470-
An object that allows additional language names to be mapped to recognized languages so they can be used on opening code fences:
471-
472-
```js
473-
{
474-
languageAliases: {
475-
fish: 'sh'
476-
}
477-
}
478-
```
479-
480-
````md
481-
Then you can use code fences like this:
482-
483-
```fish
484-
ls -la
485-
```
486-
487-
And they’ll be parsed as shell script (`sh`).
488-
````
471+
An object that allows additional language names to be mapped to recognized languages so they can be used on opening code fences.
489472

490473
- **Default:** None, but many built-in languages are already recognized by a variety of names.
474+
491475
- **Accepted type:** `Record<string, string>`; that is, an object with string keys and string values.
492476

477+
- **Example:**
478+
479+
```js
480+
{
481+
languageAliases: {
482+
fish: 'sh'
483+
}
484+
}
485+
```
486+
487+
````md
488+
Then you can use code fences like this:
489+
490+
```fish
491+
ls -la
492+
```
493+
494+
And they’ll be parsed as shell script (`sh`).
495+
````
496+
493497
### `extensions`
494498

495499
A list of third party extensions to search for additional langauges and themes. (See [Using languages and themes from an extension](#using-languages-and-themes-from-an-extension).)

0 commit comments

Comments
 (0)