Przejdź do głównej zawartości

Podstawy Markdown

notatka

Tekst, który właśnie czytasz (podobnie jak większość na tej stronie), jest zapisany w formacie Markdown właśnie.

Markdown jest szeroko używany w dokumentacji technicznej, na platformach takich jak GitHub, Reddit czy StackOverflow.

Ja go wykorzystuję do przygotowywania opisowej części audytów oraz dokumentacji (w tym instrukcji).

Opis wymagania​

Znajomość podstaw Markdown umożliwia tworzenie przejrzystych i uporządkowanych dokumentów tekstowych. Markdown jest prostym językiem znaczników, który pozwala na szybkie formatowanie tekstu.

Jeżeli potrafisz korzystać z dowolnego edytora tekstu na komputerze to jesteś już bardzo blisko znajomości tego formatu - przed Tobą tylko kilka godzin nauki, gdzie najwięcej może zająć zrozumienie wstawiania obrazków.

Wymagania szczegółowe​

  • Umiejętność formatowania tekstu (nagłówki, pogrubienie, kursywa).
  • Tworzenie list (uporządkowanych i nieuporządkowanych).
  • Dodawanie linków i obrazów dla zasobów wewnętrznych (ścieżki relatywne) oraz zewnętrznych (zaczynających się od https://...).
  • Tworzenie tabel i cytatów.

Praktyczne umiejętności​

  • Pisanie poprawnie sformatowanych dokumentów w Markdown.
  • Stosowanie podstawowych elementów formatowania.
  • Organizacja treści przy użyciu nagłówków i list.

Zadanie weryfikacyjne​

Cel:
Stworzenie prostego dokumentu w Markdown, który zawiera wszystkie podstawowe elementy formatowania.

Kroki do wykonania:

  1. Utwórz dokument z przynajmniej trzema poziomami nagłówków.
  2. Dodaj nieuporządkowaną i uporządkowaną listę.
  3. Dodaj link do dowolnej strony oraz przykładowy obraz.
  4. Wstaw cytat i prostą tabelę z trzema kolumnami.
  5. Zastosuj pogrubienie i kursywę dla wybranych fragmentów tekstu.

Kryteria oceny:

  • Dokument zawiera wszystkie wymagane elementy.
  • Formatowanie jest poprawne i czytelne.
  • Plik jest zapisany z rozszerzeniem .md.

Polecane tutoriale​