Expressive Code

A quick overview of Expressive Code features.

Themes

• Expressive Code Docs
• Available Themes

Configuration

astro.config.mjs

export default defineConfig({
  integrations: [
    starlight({
      expressiveCode: {
        themes: [
          "github-dark-dimmed",
          "github-light",
        ],
      },
    }),
  ],
});

Word Wrap

• Expressive Code Docs

No Wrap (default)

function printText() {
  if (true) {
    console.log("Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive");
  }
}

Markdown:

```js
function printText() {
  if (true) {
    console.log("Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive");
  }
}
```

Wrap

function printText() {
  if (true) {
    console.log(
      "Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive",
    );
  }
}

Markdown:

```js wrap
function printText() {
  if (true) {
    console.log(
      "Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive",
    );
  }
}
```

Unpreserved Indent

function printText() {
  if (true) {
    console.log(
      "Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive",
    );
  }
}

Markdown:

```js wrap preserveIndent=false
function printText() {
  if (true) {
    console.log(
      "Just keep examining every low bid quoted for zinc etchings. How razorback-jumping frogs can level six piqued gymnasts! A quick movement of the enemy will jeopardize six gunboats All questions asked by five watched experts amaze the judge Bobby Klun awarded Jayme sixth place for her very high quiz The wizard quickly jinxed the gnomes before they vaporized Zelda might fix the job growth plans very quickly on Monday Zack Gappow saved the job requirement list for the six boys Jackie will budget for the most expensive zoology equipment Quirky spud boys can jam after zapping five worthy Polysixes. Jim quickly realized that the beautiful gowns are expensive",
    );
  }
}
```

Editor & Terminal Frames

• Expressive Code Docs

Code Editor Frame

test-file.js

console.log("Hello, star!");

Markdown:

```js title="test-file.js"
console.log("Hello, star!");
```

File Name Comments

index.html

<h1>Home</h1>
<p>Hello, file!</p>

```html
<!-- index.html -->
<h1>Home</h1>
<p>Hello, file!</p>
```

Terminal Frame

terminal

print 'Hello, star!'

Markdown:

```zsh title="terminal"
print 'Hello, star!'
```

Override Frame Type

terminal

print 'Hello, code!'

Markdown:

```zsh title="terminal" frame="code"
print 'Hello, code!'
```

test-file.js

console.log("Hello, terminal!");

Markdown:

```js title="test-file.js" frame="terminal"
console.log("Hello, terminal!");
```

Markers

• Expressive Code Docs

Line Markers

// line 01
// line 02
// line 03
// line 04
// line 05
// line 06
// line 07
// line 08
// line 09
// line 10

Markdown:

```js {1, 3, 6-7, 10}
// line 01
// line 02
// line 03
// line 04
// line 05
// line 06
// line 07
// line 08
// line 09
// line 10
```

Marker Types ( mark, ins, del)

marker-type.js

/**
 * Apply marker type
 * @param {string} line
 * @param {string} mType="mark"
 * @returns {string|null}
 */
function markerTypes(line, mType = "mark") {
  switch (mType) {
    case "mark":
      return `<mark>${line}</mark>`;
    case "ins":
      return `<mark>'${line}'</mark>`;
    case "del":
      return `<mark>${line}</mark>`;
    default:
      return false;
  }
  if (/^mark$|^ins$|^del$/.test("mark")) {
    return `<${mType}>${line}</${mType}>`;
  } else {
    return false;
  }
}

Markdown:

```js title="marker-type.js" mark={1-6} del={8-17} ins={17-22}
/**
 * Apply marker type
 * @param {string} line
 * @param {string} mType="mark"
 * @returns {string|null}
 */
function markerTypes(line, mType = "mark") {
  switch (mType) {
    case "mark":
      return `<mark>${line}</mark>`;
    case "ins":
      return `<ins>'${line}'</ins>`;
    case "del":
      return `<del>${line}</del>`;
    default:
      return false;
  }
  if (/^mark$|^ins$|^del$/.test("mark")) {
    return `<${mType}>${line}</${mType}>`;
  } else {
    return false;
  }
}
```

Marker Labels

// line 01
// line 02
// line 03
// line 04
// line 05
// line 06
// line 07
// line 08
// line 09
// line 10

Markdown:

```js mark={"note (overlap)":1, 3-4} del={"delete":6-7} ins={"insert":9-10}
// line 01
// line 02
// line 03
// line 04
// line 05
// line 06
// line 07
// line 08
// line 09
// line 10
```

Inline Markers

// line 01: odd
// line 02: even
// line 03: odd
// line 04: even
// line 05: odd
// line 06: even
// line 07: odd
// line 08: even
// line 09: odd
// line 10: even
// "quotes"

Markdown:

```js "even" '"quotes"'
// line 01: odd
// line 02: even
// line 03: odd
// line 04: even
// line 05: odd
// line 06: even
// line 07: odd
// line 08: even
// line 09: odd
// line 10: even
// "quotes"
```

Regular Expressions

marker-type.js

function markerTypes(line, mType = "mark") {
  switch (mType) {
    case "mark":
      return `<mark>${line}</mark>`;
    case "ins":
      return `<ins>'${line}'</ins>`;
    case "del":
      return `<del>${line}</del>`;
    default:
      return false;
  }
}

Markdown:

```js title="marker-type.js" /((<|")(|/)mark("|>))|([</]{1,2}ins(>|"))|("del"|<del>|</del>)/
function markerTypes(line, mType = "mark") {
  switch (mType) {
    case "mark":
      return `<mark>${line}</mark>`;
    case "ins":
      return `<ins>'${line}'</ins>`;
    case "del":
      return `<del>${line}</del>`;
    default:
      return false;
  }
}
```

Inline Marker Types (mark, ins, del)

formatType.js

function formatType(linetext, markerType = "mark") {
  // TODO: rename stuff
  if (/^mark$|^ins$|^del$/.test("mark")) {
    return `<${markerType}>${linetext}</${markerType}>`;
  } else {
    return false;
  }
}

Markdown:

```js title="formatType.js" mark="return false;" del="line" del="// TODO: rename stuff" ins=/arker|text/
function formatType(linetext, markerType = "mark") {
  // TODO: rename stuff
  if (/^mark$|^ins$|^del$/.test("mark")) {
    return `<${markerType}>${linetext}</${markerType}>`;
  } else {
    return false;
  }
}
```

Diff Syntax

• Expressive Code Docs

Basic

deleted
added
regular

Markdown:

```diff
- deleted
+ added
  regular
```

Diff Metadata

--- a/test.md
+++ b/test01.md
@@ -1,4 +1,4 @@
 # Test

-Deleted
+Modified
 Unmodified

Markdown:

```diff
--- a/test.md
+++ b/test01.md
@@ -1,4 +1,4 @@
 # Test

-Deleted
+Modified
 Unmodified
```

Language Syntax Highlighting

function hello(name = "world") {
 const hello = "Hello " + name + "!"
 // print
 console.log(hello)
 console.log(`Hello, ${name}!`)
}

hello("star")

Markdown:

```diff lang="js"
function hello(name = "world") {
- const hello = "Hello " + name + "!"
 // print
- console.log(hello)
+ console.log(`Hello, ${name}!`)
}

hello("star")
```

Render ANSI Escape Sequences

• Expressive Code Docs

terminal

Text formatting

- Bold
- Dimmed
- Italic
- Underline


Colors

0 1 2 3 4 5 6 7  (standard)
0 1 2 3 4 5 6 7  (bright)


256-Color Mode

Standard Colors                 Bright
000 001 002 003 004 005 006 007 008 009 010 011 012 013 014 015
████████████████████████████████████████████████████████████████


216 Colors
016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051
052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087
088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████


Grayscale
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
████████████████████████████████████████████████████████████████████████████████████████████████


RGB Colors

Red - RGB(255, 0, 0)
Green - RGB(0, 255, 0)
Blue - RGB(0, 0, 255)

Markdown:

```ansi
Text formatting

- Bold
- Dimmed
- Italic
- Underline


Colors

0 1 2 3 4 5 6 7  (standard)
0 1 2 3 4 5 6 7  (bright)

256-Color Mode

Standard Colors                 Bright
000 001 002 003 004 005 006 007 008 009 010 011 012 013 014 015
████████████████████████████████████████████████████████████████


216 Colors
016 017 018 019 020 021 022 023 024 025 026 027 028 029 030 031 032 033 034 035 036 037 038 039 040 041 042 043 044 045 046 047 048 049 050 051
052 053 054 055 056 057 058 059 060 061 062 063 064 065 066 067 068 069 070 071 072 073 074 075 076 077 078 079 080 081 082 083 084 085 086 087
088 089 090 091 092 093 094 095 096 097 098 099 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231

████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████
████████████████████████████████████████████████████████████████████████


Grayscale
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
████████████████████████████████████████████████████████████████████████████████████████████████


RGB Colors

Red - RGB(255, 0, 0)
Green - RGB(0, 255, 0)
Blue - RGB(0, 0, 255)
```

Examples

terminal

                                          
                                          
                    ▆▆▅▅▄                 
                 ▃▄███████▖               
               ▗▟██████████▅              
              ▗█████████████▙             
             ▗███████████████▙            
             ▟████████████████▌           
       ▂▃▂▂▁▃█████████████████▊           
     ▗▇██▜████████████████████▉           
    ▗█▛    ▝███████████████████▇▄▄▃▁      
    ▟▛       ▔▀▀████████████████▀▀▜█▙▖    
    █▍            ▔▔▀▀▀▀▀▀▀▀▀▀▀▔   ▝██    
   ▕█▎                              ▝█▍   
   ▕█▏                               █▌   
   ▐█                                █▍   
   ▐▉                               ▕█▎   
   ▐▊                               ▐█▏   
   ▟▋                               ▐█    
   █▌    ▅▇▇▆▖                      ▐▉    
   █▍   ▟████▉             ▁▄▄▃     ▟▊    
  ▕█▎   ██████   ▁▁       ▗████▙    █▋    
  ▕█▏   ▐████▛   ▜▊  ▗▆▏  ▐█████▎   █▌    
  ▐█     ▀▜█▀    ▝█▇▅█▛   ▐█████▎   █▍    
  ▐▉              ▔▀▀▘     ▜███▀   ▕█▎    
  ▐▉                        ▔▔     ▐█▏    
  ▐█▖                              ▐█     
  ▕██▖                             ▐▉     
   ▝▜█▇▆▅▅▄▄▃▂▂▁▁                  █▊     
     ▔▀▀▀▀▜███████▇▇▆▅▅▄▃▃▂▂▁    ▂▟█▘     
                ▔▔▀▀▀▀▀▜███████▇███▘      
                             ▔▔▀▀▔