Teknik örnekler
Kod Özellikleri
Kod renklendirme, kopyalama ve aynı örneğin farklı istemci ya da provider seçenekleriyle sunulması.
Code Highlight
HTML/XML, JSON, C#, Bash, YAML ve SQL kodlarını okunabilir sözdizimi renkleriyle göstermek için kullanılır. script.code-block etiketi gösterilecek kodun parçası değildir; yalnızca sayfa kaynağında dili tanımlayan ve içeriği highlighter'a taşıyan kapsayıcıdır.
HTML'de kullanım
<script class="code-block language-json" type="text/plain">
{"ExpenseVoucherTypeCode":"SATIS","ProfileId":"GIDERPUSULASI","Lines":[{"Name":"Hizmet","Amount":1200}]}
</script>
Okuyucunun gördüğü JSON
Diğer dil örneği
public async Task SendAsync(int orderId)
{
await emailService.SendAsync(orderId);
}
language-csharp, language-bash, language-yaml veya desteklenen başka bir dil class'ı bulunmalıdır.İçerik kuralı: Handbook ve guide sayfalarında okuyucuya yalnızca gerçek JSON, XML veya kaynak kod gösterilir. script.code-block kapsayıcısı yalnızca Template feature kullanımını açıklayan teknik örneklerde görünür.
Copy Code
copy-code feature'ı mevcut pre > code bloklarına otomatik kopyalama butonu ekler. Bu sayfadaki tüm kod bloklarının sağ üstünde Copy Code butonu vardır.
copy-code.js, code-highlight.js sonrasında yüklenmelidir.<script src="features/code-highlight/code-highlight.js"></script>
<script src="features/copy-code/copy-code.js"></script>
Code Tabs
Farklı provider, istemci veya yaklaşım örneklerini aynı alanda göstermek için kullanılır. Yerel sekmeler yalnızca kendi panelini; global seçim ise aynı group değerindeki tüm panelleri değiştirir.
curl https://api.example.com/items
await client.GetAsync("/items");
.header-actions içine yerleştirilmez; bu alan yalnızca arama ve tema gibi sayfa aksiyonları içindir.data-code-option ve data-code-tabs-group değerleri üzerinden yapar.