Terjemahan disediakan oleh mesin penerjemah. Jika konten terjemahan yang diberikan bertentangan dengan versi bahasa Inggris aslinya, utamakan versi bahasa Inggris.
Bekerja dengan file README
Unggah file README.md yang berisi instruksi, diagram, dan informasi penting untuk alur kerja Anda. Setiap versi alur kerja mendukung satu file README, yang dapat diperbarui kapan saja.
Persyaratan README meliputi:
-
File README harus dalam format markdown (.md)
-
Ukuran file maksimal: 500 KiB
Gunakan README yang ada
READMEs diekspor dari repositori Git berisi tautan relatif yang biasanya tidak berfungsi di luar repositori. HealthOmics Integrasi Git secara otomatis mengonversinya menjadi tautan absolut untuk rendering yang tepat di konsol, menghilangkan kebutuhan akan pembaruan URL manual.
Untuk READMEs diimpor dari Amazon S3 atau drive lokal, gambar dan tautan harus menggunakan publik URLs atau jalur relatifnya diperbarui untuk rendering yang tepat.
catatan
Gambar harus di-host secara publik untuk ditampilkan di HealthOmics konsol. Gambar yang disimpan GitHub Enterprise Server atau GitLab Self-Managed repositori tidak dapat dirender.
Kondisi rendering
HealthOmics Konsol menginterpolasi gambar dan tautan yang dapat diakses publik menggunakan jalur absolut. Untuk merender URLs dari repositori pribadi, pengguna harus memiliki akses ke repositori. Untuk GitHub Enterprise Server atau GitLab Self-Managed repositori, yang menggunakan domain khusus, HealthOmics tidak dapat menyelesaikan tautan relatif atau merender gambar yang disimpan di repositori pribadi ini.
Tabel berikut menunjukkan elemen penurunan harga yang didukung oleh tampilan README AWS konsol.
Elemen | AWS konsol |
---|---|
Peringatan | Ya, tetapi tanpa ikon |
Lencana | Ya |
Pemformatan teks dasar | Ya |
Blok kode |
Ya, tetapi tidak memiliki sorotan sintaks |
Bagian yang dapat dilipat | Ya |
Judul |
Ya |
Format gambar |
Ya |
Gambar (dapat diklik) |
Ya |
Jeda baris |
Ya |
Diagram putri duyung | Hanya dapat membuka grafik, memindahkan posisi grafik, dan menyalin kode |
Kutipan | Ya |
Subskrip dan superskrip |
Ya |
Tabel |
Ya, tetapi tidak mendukung perataan teks |
Penjajaran teks | Ya |