Koodi
Koodien hallinta MDX-tiedostoissasi
opendocs käyttää rehype-pretty-code -kirjastoa
koodien käsittelyyn MDX-tiedostoissa. Tämän avulla voit mukauttaa koodien näyttötapaa merkittävästi!
Lisätietoja saat virallisesta dokumentaatiosta ja esimerkeistä!
Otsikot
Esimerkki:
import { App } from './App';Koodi:
```js title="apps/web/src/index.tsx"
import { App } from './App';
```Koodin korostus
Esimerkki:
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}Koodi:
```js
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}
```Rivinsisäisen koodin korostus
Esimerkki:
The result of [1, 2, 3].join('-') is '1-2-3'.
Koodi:
The result of `[1, 2, 3].join('-'){:js}` is `'1-2-3'{:js}`.Kontekstitietoinen rivinsisäisen koodin korostus
Jos sinulla olisi esimerkiksi seuraava koodilohko:
function getStringLength(str) {
return str.length;
}Kun viittaamme getStringLength-arvoon funktiona,
voimme värittää sen sen mukaisesti. Sama koskee function-arvoa tai
str vs. str jne. Tämä mahdollistaa
rivinsisäisen koodin semanttisen linkittämisen lähimpään koodilohkoon, johon se viittaa.
Koodi:
When we refer to `getStringLength{:.entity.name.function}` as a function,
we can color it as such. Same with `function{:.keyword}`, or
`str{:.variable.parameter}` vs. `str{:.variable.other.object}`, etc. This allows
semantically link inline code to the nearest block of code it refers to.Sanojen korostus
Esimerkki:
relative w-full pl-12 rounded-lg borderKoodi:
```css /pl-12/ /border/
relative w-full pl-12 rounded-lg border
```Rivien korostus
Esimerkki:
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}Koodi:
```js {2-4,6}
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}
```Rivinumerointi
Esimerkki:
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}Koodi:
```js showLineNumbers
module.exports = {
theme: {
extend: {
colors: {
warning: "hsl(var(--warning))",
"warning-foreground": "hsl(var(--warning-foreground))",
},
},
},
}
```Diff
Esimerkki:
const alertVariants = cva(
- "relative w-full rounded-lg border",
+ "relative w-full pl-12 rounded-lg border"
)Koodi:
```diff
const alertVariants = cva(
- "relative w-full rounded-lg border",
+ "relative w-full pl-12 rounded-lg border"
)
```ANSI-korostus
Esimerkki:
vite v5.0.0 dev server running at:
> Local: http://localhost:3000/
> Network: use `--host` to expose
ready in 125ms.
8:38:02 PM [vite] hmr update /src/App.jsxRivinsisäinen ANSI: > Local: http://localhost:3000/
Koodi:
```ansi
[0;36m vite v5.0.0[0;32m dev server running at:[0m
> Local: [0;36mhttp://localhost:[0;36;1m3000[0;36m/[0m
> Network: [0;2muse `--host` to expose[0m
[0;36mready in 125ms.[0m
[0;2m8:38:02 PM[0m [0;36;1m[vite][0m [0;32mhmr update [0;2m/src/App.jsx
```
Inline ANSI: `> Local: [0;36mhttp://localhost:[0;36;1m3000[0;36m/[0m{:ansi}`Sanaryhmän korostus tunnisteen mukaan
Lisää tunniste #-merkin jälkeen sanojen perään.
Tämän avulla voit värittää merkkejä eri tavalla annetun tunnisteen perusteella.
Esimerkki:
const [age, setAge] = useState(50);
const [name, setName] = useState("Taylor");Koodi:
```js /age/#v /name/#v /setAge/#s /setName/#s /50/#i /"Taylor"/#i
const [age, setAge] = useState(50);
const [name, setName] = useState("Taylor");
```Tyylien muuttaminen tai uusien lisääminen:
[data-chars-id='v'] {
@apply !text-pink-300 bg-rose-800/50 font-bold;
}