Markdown i plik README.md

Markdown to zestaw reguł, język znaczników używany do formatowania tekstu.
Najczęściej wykorzystuje się go do tworzenia opisów projektów w serwisie GitHub, jako plik README.md (pisany kapitalikami), zawierający wprowadzenie i informacje o projekcie. Tu powinien się znaleźć opis instalacji aplikacji, wykaz najważniejszych funkcji. Więcej w kontekście WP o pliku readme.md.

Rozszerzenie .md to skrót od słowa Markdown.

Symbole

# – nagłówek H1 1 rzędu, każdy nagłówek jest od razu podlinkowany
## H2
### H3
#### H4
##### H5
###### H6

=  znak równości linię pod tekstem który ma być nagłówkiem h1 bez potrzeby wpisywania #, nadaje styl H1
–  znak minusa linię pod tekstem który ma być nagłówkiem h2 bez potrzeby wpisywania #, nadaje styl H2

` ` `  trzy znaki gravis (obok siebie bez spacji) (na tym samym klawiszu co znak tyldy~) nad linią i trzy znaki gravis pod linią – zamykają wprowadzoną linię, lub linie w szare pole znacznika pre i code

**text** lub __text__  dwa znaki gwiazdki (lub podkreślenia) przed wyrazem, lub wyrazami i dwa znaki gwiazdki (lub podkreślenia) po – pogrubienie tekstu

*text* lub _text_  pojedynczy znak gwiazdki (lub podkreślenia) przed wyrazem, lub wyrazami i pojedynczy znak gwiazdki (lub podkreślenia) po – tekst pisany kursywą

~~text~~  dwa znaki tyldy przed wyrazem, lub wyrazami i dwa znaki tyldy po – przekreślenie tekstu

–  zaczęcie od znaku myślnika – daje punktor listy nie uporządkowanej,

zagnieżdżenie w liście ul robi się przez wcięcie spacjami przed myślnikiem, najlepiej 2 spacje, ponieważ GitHub to akceptuje. Ważne byś używał spacji, nie tabów, niektóre parsery Markdown źle interpretują taby.

>  znak większości przed tekstem zamyka go w blockquote, wizualnie poprzedzone szarą pionowa linią przed tekstem

pozwala na wstawianie emoji:
Ważne / krytyczne
⚠️ WARNING / UWAGA
❗ WAŻNE
🔴 Ważne
🛑 STOP / breaking change

Informacja / kontekst
ℹ️ info
🔵 info
📝 notatka
💡 TIP
📌 wskazówka / zapamiętaj

Pytania / do sprawdzenia / decyzje
❓ Pytanie
🔍 Do sprawdzenia
🧪 Do przetestowania

Status / checklisty
Idealne do TODO i roadmap.
✅ Gotowe
⏳ W trakcie
❌ Nie zrobione
🟡 Częściowo

Techniczne / developerskie
Do sekcji stricte technicznych.
🧩 Logika / architektura
🛠 Implementacja
🧱 Template / struktura
⚙️ Konfiguracja
🧪 Testy
🐞 Bug

Zmiany / wersjonowanie
Bardzo przydatne w CHANGELOG.
🔄 Zmiana
🆕 Nowe
♻️ Refactor
🧹 Cleanup
🗑 Usunięte

W projekcie dobrze pierw zaznaczyć jakie emoji co oznaczają, np:
Ważne ⚠️
Info ℹ️
Tip 💡
TODO ⏳
Gotowe ✅
Do sprawdzenia ❓
Techniczne ⚙️

 

Dodanie linku

[I’m an inline-style link](https://webscene.pl)

Lista z checkboxami (TODO lista)

– [ ] Zadanie do zrobienia
– [x] Zadanie wykonane
– [ ] Kolejne zadanie

Lista z kodem wewnątrz podpunktu

– Dodaj filtr `manage_page_posts_columns`

Blok kodu w podpunkcie

Ważne: wcięcie 4 spacje lub 1 tab przed ` ` `

– Dodanie kolumny w adminie:

` ` `php
add_filter(’manage_page_posts_columns’, function($columns) {
$columns[’ebook’] = 'Ebook’;
return $columns;
});
` ` `

Zagnieżdżenie w numerowanej liście (ol + ul)

1. Instalacja motywu
– Skopiuj folder do `/wp-content/themes`
– Aktywuj motyw w panelu

2. Konfiguracja ACF
– Dodaj pole `page_ebook_site`
– Ustaw typ True/False

Narzędzia do edycji

• online przez stackedit.io
• w VS Code dzięki pluginowi GitHub Markdown Preview

Dodatkowe uzupełnienie: Markdown Cheatsheet