Skip to content
This repository was archived by the owner on Feb 6, 2024. It is now read-only.

Commit 1612586

Browse files
doc: optional terminal style configuration
1 parent e68eb7f commit 1612586

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

README.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,8 @@ Furthermore, the inspiration for the design of the cards comes from the amazing
1818
- [Load the component](#load-the-component)
1919
- [Language](#language)
2020
- [Styling](#styling)
21+
- [Terminal](#terminal)
22+
- [Variables](#variables)
2123
- [Showcase](#showcase)
2224
- [License](#license)
2325

@@ -75,6 +77,37 @@ This plugin supports all languages supported by [Prism.js](https://prismjs.com).
7577

7678
## Styling
7779

80+
Code blocks are displayed in stylish cards but the behavior could be customized.
81+
82+
### Terminal
83+
84+
Per default, code blocks are going to be displayed in `carbon` ("Macish like") container.
85+
86+
It is also possible to use `ubuntu` (an Ubuntu-like container) or `none` (no window container).
87+
88+
Such settings can be provided in the configuration of the plugin.
89+
90+
```javascript
91+
// In your gatsby-config.js
92+
plugins: [
93+
{
94+
resolve: `gatsby-transformer-remark`,
95+
options: {
96+
plugins: [
97+
{
98+
resolve: `gatsby-remark-highlight-code`,
99+
options: {
100+
terminal: 'ubuntu'
101+
}
102+
},
103+
],
104+
},
105+
},
106+
]
107+
```
108+
109+
### Variables
110+
78111
See the [@deckdeckgo/highlight-code] documentation for the list of CSS4 styling variables.
79112

80113
## Showcase

0 commit comments

Comments
 (0)