Etkileyici Bir README.md Yazısı Hazırlama

Teknokodi
readme

README.md

Bu bölümde basit ve güzel README dosyası hazırlama konusunu ele alacağız. Github, Bitbucket ve Gitlab gibi yazılımcıların projelerini sakladığı ve paylaştığı sitelerde projelerin açıklamasını ve projeyle alakalı başka bilgiler içeren yazıları yazdığımız dosya olan README.md dosyasında kullanılan tüm özellikleri ele alacağız.

README.md Dosyasına Başlık Ekleme

Başlık eklemek için # işareti kullanılır. Bu işaret html de ki başlık etiketlerine (h tagları) denk gelmektedir. Kullanımı ise;

# Başlık 1
## Başlık 2
### Başlık 3
#### Başlık 4
##### Başlık 5
###### Başlık 6

readme.md, readme başlık ekleme

 

README.md Dosyasına Kalın, İtalik Yazı ve Alt Çizgi Ekleme

Kalın yazı eklemek için yazıları ** işareti kullanılır. İtalik yazı eklemek için ise _ işareti kullanılır. Alt çizgi eklemek için ise — (3 adet) tire (-) kullanılır.  Kullanımı;

**kalın yazı**

_italik yazı_

—

readme.md, readme kalın italik yazı

README.md Dosyasına Liste Elemanı Ekleme

Liste elemanlarını eklemek için – işareti kullanılır. Kullanımı;

readme.md, readme liste etiketi

– Birinci Etiket (İçi dolu daire olarak görünür.)
— İkinci Etiket (Tire olarak görünür.)
– Üçüncü Etiket (İçi boş daire olarak görünür.)
– Dördüncü Etiket (Kare olarak görünür.)
— Beşinci Etiket

README.md Dosyasına Alıntı Ekleme

Alıntı eklemek için > işareti kullanılır. Kullanımı;

> Bu bir alıntı metni olarak
Teknokodi blog sitesi için yazılmıştır.

yada

> Bu bir alıntı metni olarak
> Teknokodi blog sitesi için yazılmıştır.

readme.md, readme alıntı yazısı ekleme

README.md Dosyasına Link Ekleme

Link eklemek için 2 yol vardır. Kullanımları;

[Teknokodi Youtube] – Teknokodi blog sayfasının youtube hesabı

[Teknokodi Youtube]: <https://www.youtube.com/channel/UC6ndYQW9mjsgOpz_hr95yEA> (sayfanın en sonuna eklenmelidir.)

yada tek satırda yazmak için

[Instagram](https://www.instagram.com/teknokodi/?hl=tr) – Teknokodi blog sayfasının instagram hesabı

readme.md, readme dosyasına link ekleme

README.md Dosyasına Tablo Ekleme

Tablo eklemek için | işareti kullanılır. Kullanımı;

| Başlık1 | Başlık2 | Başlık3 |
| —— | —— | —— |
| Satır 1 Sütun 1 | Satır 1 Sütun 2 | Satır 1 Sütun 3 |
| Satır 2 Sütun 1 | Satır 2 Sütun 2 | Satır 2 Sütun 3 |
| Satır 3 Sütun 1 | Satır 3 Sütun 2 | Satır 3 Sütun 3 |
| Satır 4 Sütun 1 | Satır 4 Sütun 2 | Satır 4 Sütun 3 |
| Satır 5 Sütun 1 | Satır 5 Sütun 2 | Satır 5 Sütun 3 |

readme.md, readme dosyasına table ekleme

README.md Dosyasına Kod Bloğu Ekleme

Kod bloğu eklemek için “` işareti kullanılır. Kullanımı;

“`
cd teknokodi
npm i
npm run serve
“`

readme.md, readme dosyasına kod ekleme

README.md Dosyasına Yazıya Kırmızı Stil Ekleme

Yazıya kırmızı stil eklemek için ` işareti kullanılır. Kullanımı;

Merhabalar. `Teknokodi` blog sayfasına hoş geldiniz.

readme.md, readme kırmızı stil ekleme

Youtube kanalımızdan bizleri takip edebilirsiniz.

TEKNOKODİ

Okunma Sayısı 2.785

İlgili Yazılar

Leave a Comment