dygresje.info / IT / JavaScript

Spis treści

Markdown

Język znaczników

Markdown - język znaczników. Powstał w 2004 jako prosty system formatowania tekstu, tak by był jednocześnie:

  • łatwy w tworzeniu
  • czytelny w swojej natywnej formie
  • łatwy do konwersji na inne formaty, gł HTML i LaTeX

Z tych założeń wynika jego prostota. Znają go wszyscy wikipedyści, wikikod to po prostu markdown, z którego silnik mediawiki generuje treść strony.

Dzięki powyższym cechom Markdown jest najlepszą formą tworzenia dokumentacji. Natywnie zawiera w sobie większość cech potrzebnych przy tworzeniu zhierarchizowanego tekstu. Brakujące łatwo można uzupełnić przez różnego rodzaju dodatki. Największe możliwości daje popularne środowisko Pandoc. Mając już czytelny i posiadający wszystkie elementy formatowania plik źródłowy .md można go skonwertować na większość formatów dokumentów, najważniejsze to PDF, HTML i Latex.

Przejście do następnej lini: \ na końcu wiersza

Visual Studio Code

Lokalna kopia repozytorium na Githubie, pliki w formacie Markdown i VSC to - jak mi się zdaje - idealne połączenie na trzymanie i wygodną edycję, stale archiwizowanych plików i wygodnych w edycji plików z notatkami, dokumentacją, kodem.

Także dotyczy to stale rozwijanych artykułów na CMS. W tym ostatnim przypadku jest to już HTML, ale zapisany w formacie Markdown. Jak zmusić VSC do stosowania skrótów Emmeta w Markdown? - markdown not using emmet. W konfiguracji:


 "emmet.triggerExpansionOnTab": true,
 "emmet.excludeLanguages": [],
 "emmet.includeLanguages": {
 "markdown": "html"
 },
  

Dodatki:

  • markdownlint by David Anson
  • Markdown Preview Enhanced by Yiyi Wang - podgląd
  • Markdown All in One by Yu Zhang - generowanie TOC
  • inne: LaTeX Workshop, Citation Picker for Zotero
  • Dendron The hierarchical note taking tool

Odnośniki Markown

Narzędzia

  • pbek / QOwnNotes plain-text file notepad and todo-list manager with markdown support and Nextcloud / ownCloud integration. - QOwnNotes

Odnośniki MDX

Dendron