Kiedy plik Word musi stać się zwykłym tekstem ze strukturą
Dokumentacja często zaczyna życie w Wordzie: specyfikacja napisana przez product managera, polityka przygotowana przez dział prawny, instrukcja przekazana przez klienta. Celem bywa jednak repozytorium Git, generator stron statycznych, wiki, baza wiedzy albo aplikacja do notatek — a wszystkie one mówią w Markdown. Kopiuj-wklej gubi nagłówki i listy, a ręczne przepisanie 20-stronicowego dokumentu zajmuje godziny.
Markdown to także dobry format do archiwizacji i przeglądu. W systemie kontroli wersji różnice widać przejrzyście, więc po konwersji umowy lub dokumentu wymagań możesz śledzić każdą późniejszą zmianę linia po linii — na co binarny plik .docx nie pozwala.
Jak działa konwersja
Plik .docx to archiwum ZIP z plikami XML. Konwerter otwiera je w przeglądarce, odczytuje treść dokumentu i najpierw mapuje strukturę Worda na HTML, a potem zamienia ten HTML w Markdown. Oba kroki korzystają z tych samych reguł Markdown co konwerter HTML na Markdown w tym serwisie, więc wyniki obu narzędzi wyglądają spójnie.
Co jest przenoszone i jak jest zapisywane:
- Nagłówki stają się
#do######, po jednym poziomie na każdy poziom nagłówka Worda od 1 do 6. - Pogrubienie staje się
**tekst**, a kursywa —_tekst_. - Listy punktowane i numerowane stają się listami
-i1., z zachowanym zagnieżdżeniem do pięciu poziomów. - Hiperłącza stają się
[tekst](url), łącznie z linkami do zewnętrznych stron. - Tabele stają się tabelami z pionowymi kreskami, a pierwszy wiersz służy jako nagłówek.
- Przypisy dolne i końcowe są zbierane w numerowaną listę na końcu dokumentu, a każde odwołanie w tekście staje się linkiem do swojego przypisu.
Wynik jest porządkowany tak, by między blokami nigdy nie było więcej niż jednej pustej linii.
Dlaczego nagłówki czasem wychodzą jako zwykły tekst
Konwerter rozpoznaje nagłówek po stylu akapitu, a nie po wyglądzie. Linia sformatowana wbudowanymi stylami od Nagłówek 1 do Nagłówek 6 staje się nagłówkiem Markdown. Linia, którą autor ręcznie powiększył i pogrubił, jest z punktu widzenia pliku zwykłym akapitem z pogrubionym tekstem i wychodzi jako **Wstęp**, a nie ## Wstęp.
To samo dotyczy tytułu dokumentu. Styl Tytuł w Wordzie nie jest stylem nagłówka, więc ustawiony nim tytuł staje się zwykłym akapitem. Jeśli struktura ma znaczenie, popraw ją w Wordzie przed konwersją: zaznacz linię i zastosuj Nagłówek 1 lub Nagłówek 2 z galerii Style. Szybki sposób na sprawdzenie dokumentu to Okienko nawigacji w Wordzie, które pokazuje tylko prawdziwe nagłówki. Czego brakuje tam, tego zabraknie też w konspekcie Markdown.
Co zostaje pominięte
Markdown jest celowo prosty, więc wiele elementów układu Worda nie ma w nim odpowiednika:
- Obrazy nie są dołączane, a komunikat informuje, ile z nich pominięto. Osadzanie ich jako tekstu base64 sprawiłoby, że plik byłby wielokrotnie większy od samego tekstu.
- Podkreślenie, czcionka, rozmiar i kolor są pomijane. Markdown nie ma dla nich składni.
- Przekreślony tekst zostaje, ale bez przekreślenia.
- Nagłówki i stopki stron, numery stron i podziały sekcji należą do układu strony, a nie do treści, i nie są konwertowane.
- Pola tekstowe i kształty mogą zginąć lub pojawić się w niewłaściwym miejscu, bo „pływają” poza głównym tokiem tekstu.
- Formatowanie komórek tabeli jest spłaszczane do zwykłego tekstu. Pogrubienia, linki czy listy wewnątrz komórki tracą formatowanie, a akapity komórki z wieloma akapitami są łączone w jedną linię, czasem bez spacji między nimi.
Praktyczne porządki po konwersji
Markdown jest zwykle gotowy w 90 procentach. Krótki przegląd naprawia resztę:
- Przejrzyj nagłówki. Upewnij się, że jest jeden nagłówek najwyższego poziomu
#, jeśli Twoja strona tego oczekuje, i że poziomy nie przeskakują od#od razu do###. - Sprawdź listy numerowane przerwane akapitem lub obrazem. Markdown może zacząć numerację od 1 na nowo.
- Przyjrzyj się tabelom ze scalonymi komórkami, które wychodzą jako wiersze o różnej liczbie kolumn, i wyrównaj je ręcznie.
- Dodaj z powrotem obrazy: wyeksportuj je z Worda, umieść pliki obok pliku .md i wstaw
tam, gdzie powinny się znaleźć. - Przed publikacją obejrzyj wynik w podglądzie narzędzia Markdown na HTML.
Akceptowane są pliki do 50 MB, ale nie stary binarny format .doc. Dokument jest odczytywany wyłącznie w karcie przeglądarki, więc poufne szkice nigdy nie trafiają na serwer.