Komponen Konten
Semua komponen yang tersedia di GitDocs beserta sintaks Markdown-nya, dalam satu halaman.
Di halaman ini
GitDocs memahami Markdown standar (GFM) plus sintaks komponen ala GitBook. Halaman ini merangkum semuanya; tiap komponen dibahas lebih dalam di subhalaman.
Teks tebal, miring, coret, kode sebaris, tombol Ctrl + K, dan tautan — termasuk tautan eksternal yang otomatis diberi ikon.
Kutipan tampil dengan garis tepi di kiri dan teks lebih lembut.
- Daftar bernomor
- Butir kedua
- Daftar bersarang
- Butir lain
- Butir ketiga
- Daftar tugas yang sudah selesai
- Yang belum selesai
| Sintaks | Hasil |
|---|---|
**tebal** |
tebal |
*miring* |
miring |
`kode` |
kode |
~~coret~~ |
Info — untuk konteks tambahan yang perlu diketahui pembaca.
Tips — praktik terbaik atau jalan pintas yang mempermudah pekerjaan.
Peringatan — hal yang mudah keliru dan sebaiknya diperiksa dua kali.
Bahaya — tindakan yang bisa menghilangkan data atau merusak situs.
add_filter( 'gitdocs_example', function ( $value ) {
return strtoupper( $value );
} );npm
npm installpnpm
pnpm installApakah komponen bisa disarangkan?
Bisa. Callout boleh berisi blok kode, tab boleh berisi callout, dan akordeon boleh berisi keduanya.
Contoh callout di dalam akordeon.
Kelebihan
- Cepat dibuka
- Mudah dicari
Perlu diperhatikan
- Butuh permalink aktif
- Butuh PHP 8
Komponen content-ref membuat kartu tautan seperti yang dipakai di halaman ini — berguna untuk mengarahkan pembaca ke langkah berikutnya.
Rumus ditulis dengan $$ dan dirender menjadi MathML asli oleh peramban:
E = mc^2Rumus sebaris juga bisa: a^2 + b^2 = c^2 di tengah kalimat.
| Komponen | Sintaks singkat |
|---|---|
| Callout | {% hint style="info" %} … {% endhint %} |
| Tab | {% tabs %}{% tab title="…" %} … |
| Akordeon | <details><summary>…</summary> … |
| Langkah | {% stepper %}{% step %} … |
| Kolom | {% columns %}{% column %} … |
| Embed | {% embed url="…" %} |
| Kartu halaman | {% content-ref url="…" %} |
| Berkas | {% file src="…" %} |
| Rumus | $$ … $$ |
| Diagram | ```mermaid |
Sintaks :::info … ::: ala Docusaurus dan peringatan ala GitHub (> [!WARNING]) juga dikenali, sehingga dokumen dari sumber lain bisa ditempel apa adanya.