Walka z markdown

2021/12/03

Categories: informatyka Tags: tagi pisanie TeX DTP Hugo

Table of Contents

Miało być łatwiej

Do tej pory zwykle pisałem teksty bezpośrednio posługując się językiem HTML. Stara część strony zbudowana jest właśnie takim sposobem. Nie wydawało mi się to czymś szczególnie upierdliwym, tym bardziej, że przyzwyczaiłem się do takiego działania off-line, do tekstów ze znacznikami. Tak pracowało się z WordPerfectem, TeX-em, HTML-em. Nawet Ventura Publisher opierała formatowanie o znaczniki.

Dlaczego teraz przesiadam się, przynajmniej częściowo, na język markdown oraz generator stron statycznych Hugo. Po części jest to ciekawość, czy będzie to dla mnie jakaś oszczędność czasu, ale druga — niemniej istotna strona — związana jest z tym, że taki opis występuje w różnych Wiki, więc być może będę mógł łatwiej pewne informacje wymieniać korzystając z tego formatu, który potem mogę konwertować.

Na pewno tworzenie indeksów, zliczanie znaczników nie byłoby proste do zrobienia ręcznie i tutaj też upatruję pewnego zysku. Zdarzało mi się od czasu do czasu pisać coś, co określałem jako miniesej. Rozrzut tematyki był bardzo duży, więc automatyczne indeksowanie jest na pewno przydatne.

Na razie jednak zmagam się ze swoimi nawykami, a to wetknę tyldę, jako twardą spację, a to pomylę liczbę hashy w hierarchii tesktu. Bardziej się muszę skupiać nad pisaniem, niż gdybym używał bezpośrednio LaTeX-a, ale to pierwsze koty za płoty.

Koncepcja Hugo zaczyna mi się coraz bardziej podobać, jednak dokumentacja, od której zacząłem pozostawiała wiele do życzenia. Ot chcociażby z powodu niezbyt precyzyjnego adresu czytelniczego. Ci, co nie mają pojęcia jak zacząć Quick start pozostawia w dużej niepewności, natomiast innym nic nie daje. Niestety to bardzo częsty błąd przy pisaniu dokumentacji technicznej. Autor nie zastanawia się dla kogo pisze.

Ważna jest dla mnie możliwość wkładania tutaj wzorów:

$$ \begin{aligned} \rho\left(\frac{\partial\underline{v}}{\partial t}+\underline{v}\cdot\underline{\nabla}\underline{v}\right) & =-\underline{\nabla}p+\mu\nabla^{2}\underline{v}+\rho\underline{g} \\ \rho\frac{D\underline{v}}{Dt} & =-\underline{\nabla}p+\underline{\nabla}\cdot\underline{\underline{\sigma}}+\rho\underline{g} \\ \rho\frac{D\underline{v}}{Dt} & =-\underline{\nabla}p+\mu\nabla^{2}\underline{v}+\rho\underline{g} \end{aligned} $$

Oraz diagramów w postaci opisu symbolicznego.

graph LR;
    A[Hard...] -->|Dalej | B(Round...)
    B --> C{Decision...}
    C -->|One...| D[Result one...]
    C -->|Two...| E[Result two...]

>> Home