Przejdź do treści

Artykuł zastępczy — Ta strona powstała po to, by przećwiczyć mechanikę dokumentacji. Nie jest gotową dokumentacją i nie należy na niej polegać.

Podświetlanie kodu

Po jednym bloku na każdą wstępnie wczytaną gramatykę Shiki — próbka, nie strona referencyjna.

Ta strona jest próbką. Niesie dokładnie jeden blok kodu na każdy język wymieniony w shiki-languages.json, a scripts/check-generated-docs.mjs sprawdza, że każdy z nich wyszedł z builda z kolorowymi znacznikami.

O to sprawdzenie tu chodzi. Gramatyka, której Shiki nie wczytał wstępnie, nie psuje builda, nie ostrzega i nie rzuca wyjątkiem: blok renderuje się jako zwykły, nieostylowany tekst. Nic poza asercją na wygenerowanym HTML tego nie wyłapie.

TypeScript

export interface Session {
  readonly id: string
  expiresAt: Date
}

TSX

export default function Callback() {
  return <p>Logujemy Cię…</p>
}

JavaScript

export const issuer = new URL('https://id.example.com')

Python

from datetime import datetime


def expired(session: dict) -> bool:
    return session["expires_at"] < datetime.now()

JSON

{
  "issuer": "https://id.example.com",
  "scopes_supported": ["openid", "profile"]
}

Bash

export KLEORA_ISSUER="https://id.example.com"

Shell

curl -fsS "$KLEORA_ISSUER/.well-known/openid-configuration"

HTML

<a href="/pl/docs">Dokumentacja</a>

Vue

<script setup lang="ts">
const { data } = await useFetch('/api/session')
</script>

<template>
  <p>{{ data?.id }}</p>
</template>

YAML

issuer: https://id.example.com
scopes:
  - openid
  - profile