Lompat ke konten
dokumentasi.id
Masuk
dokumentasi.idKristoriesawesome-guidelines
Commit a27b09d
v1
Star11 rb

Kamu membaca versi lama. Halaman ini hanya bisa dibaca.

Navigasi sumber

3

Katalog Panduan

README.md memuat seluruh katalog panduan repository ini dalam satu berkas. Bagian ## Contents di awal dokumen hanya berisi enam tautan anchor tingkat dua, tanpa satu pun tautan ke subbagian ### (README.md:5-12). Karena itu hierarki sebenarnya ditentukan oleh heading ## dan ### di badan dokumen, bukan oleh daftar isi.

graph TD
  IDX["## Contents · 6 anchor"]
  IDX --> PL["## Programming Languages"]
  IDX --> DE["## Development Environment"]
  IDX --> PF["## Platforms"]
  IDX --> FW["## Frameworks"]
  IDX --> CM["## Content Management System"]
  IDX --> TL["## Tools"]
  PL --> PL1["43 × heading ###"]
  DE --> DE1["3 × heading ###"]
  PF --> PF1["15 × heading ###"]
  FW --> FW1["flat list"]
  CM --> CM1["flat list"]
  TL --> TL1["flat list"]
  PL1 --> PLX["### Ada ... ### XML"]
  PF1 --> PFO["### Other"]
  style IDX fill:#8b5cf6,color:#fff
  style PL fill:#2d7d46,color:#fff
  style DE fill:#2d7d46,color:#fff
  style PF fill:#2d7d46,color:#fff
  style FW fill:#f59e0b,color:#000
  style CM fill:#f59e0b,color:#000
  style TL fill:#f59e0b,color:#000
  style PFO fill:#f59e0b,color:#000
  %% fig: Hierarki kategori dan subbagian README
  %% desc: Enam anchor di Contents memetakan ke enam heading H2, tiga kategori punya subbagian H3 dan tiga kategori lain berupa flat list.
Fig. 1: Hierarki kategori dan subbagian READMEEnam anchor di Contents memetakan ke enam heading H2, tiga kategori punya subbagian H3 dan tiga kategori lain berupa flat list.

Kategori bertingkat dan kategori datar tidak diperlakukan sama. Tabel berikut mencatat rentang baris dan jumlah subbagian tiap kategori.

Kategori ##Rentang barisSubbagian ###Rentang namaHalaman
Programming Languages14–24443### Ada → ### XMLProgramming Languages
Development Environment246–2593### Shell → ### PowerShellDevelopment Environment
Platforms261–34715### Android → ### OtherPlatform
Frameworks349–3540flat listFrameworks, CMS, dan Tools
Content Management System356–3610flat listFrameworks, CMS, dan Tools
Tools363–3760flat listFrameworks, CMS, dan Tools

Jumlah subbagian berjumlah 61 dan semuanya berada pada tiga kategori pertama (README.md:14-244, README.md:246-259, README.md:261-347). Kategori Frameworks, Content Management System, dan Tools langsung menaruh bullet di bawah heading ##, sehingga isinya dibahas di Frameworks, CMS, dan Tools (README.md:349-354, README.md:356-361, README.md:363-376). Urutan entri pada kategori datar dibahas di Format Entri dan Pengurutan.

Aturan pengurutan abjad subbagian

Subbagian ### dalam satu kategori diurutkan menurut abjad, dan perbandingannya tidak membedakan huruf besar/kecil. Bacaan itu berasal dari tiga jejak di berkas.

BuktiLetakKesimpulan
### Markdown, ### .NET, ### NimREADME.md:145-159titik di awal nama diabaikan, kunci urut dibaca NET
### Perl, ### PHP, ### PythonREADME.md:172-189pembandingan tidak peka huruf besar/kecil
### Java, ### JavaScript, ### JSONREADME.md:109-132nama yang menjadi awalan nama lain diurut lebih dahulu

Aturan ini berlaku pada tingkat heading. Posisi satu entri di dalam subbagian tidak diatur olehnya.

Simpangan dari pola urutan

Dua subbagian di ## Platforms tidak berada pada posisi abjadnya. Rantai berikut menunjukkan urutan apa adanya di berkas.

graph LR
  GNU["### GNU · L302"] --> JAVA["### Java · L306"]
  JAVA --> LINUX["### Linux · L310"]
  LINUX --> MC["### Mailchimp · L314"]
  MC --> MOZ["### Mozilla · L318"]
  MOZ --> GOOG["### Google · L322"]
  GOOG --> NODE["### Node.js · L326"]
  NODE --> MONGO["### MongoDB · L331"]
  MONGO --> SQL["### SQL · L335"]
  SQL --> OTHER["### Other · L339"]
  style GOOG fill:#dc2626,color:#fff
  style MONGO fill:#dc2626,color:#fff
  style OTHER fill:#f59e0b,color:#000
  style GNU fill:#2d7d46,color:#fff
  style JAVA fill:#2d7d46,color:#fff
  style SQL fill:#2d7d46,color:#fff
  %% fig: Urutan subbagian Platforms apa adanya
  %% desc: Rantai heading H3 Platforms sesuai baris di README, dua node merah berada di luar posisi abjad dan Other adalah wadah penampung.
Fig. 2: Urutan subbagian Platforms apa adanyaRantai heading H3 Platforms sesuai baris di README, dua node merah berada di luar posisi abjad dan Other adalah wadah penampung.
SubbagianBarisPosisi abjadnya
### GoogleREADME.md:322-324di antara ### GNU (README.md:302-308)
### MongoDBREADME.md:331-333sebelum ### Mozilla dan ### Node.js (README.md:318-329)

Wadah penampung ### Other

### Other di bawah ## Platforms mengumpulkan panduan yang tidak terikat satu bahasa atau platform tertentu, misalnya panduan CHANGELOG, Semantic Versioning, dan CodeQL Coding Standards (README.md:339-347). Subbagian ini diletakkan paling akhir di kategorinya, setelah ### SQL, sehingga tidak mengikuti kunci abjad.

⚠️ Nama heading ### Java dipakai dua kali, yaitu di ## Programming Languages dan di ## Platforms (README.md:109-115, README.md:306-308). Daftar isi saat ini tidak terpengaruh karena hanya menautkan heading ## (README.md:5-12), tetapi tautan ke subbagian harus selalu menyebut kategorinya.