Markdown i Pandoc

Paweł Mleczko

2018-01-17

O czym będziemy mówić?

Markdown
Pandoc

Dlaczego o tym będziemy mówić?

Produkujemy ogromne ilości plików (sprawozdania, konspekty, prace zaliczeniowe, notatki etc.).

Jak zorganizować pracę, by była ona efektywna?

O czym już mówiliśmy? O czym mówić nie będziemy?

Jak chronić swoje archiwum plików?

Jak zorganizować swoje archiwum? (czy wszystkie pliki można gromadzić na pulpicie?)

Markdown

Czym jest Markdown?

Markdown jest językiem przeznaczonym do formatowania tekstów.

Cechy i zalety:

plik tekstowy (często z rozszerzeniem md)
prostota pisania
szybkość edycji tekstów
niezależny od systemu operacyjnego
,,rozumiany’’ przez wiele programów zarządzania treścią

Kto używa Markdowna?

GitHub
Reddit
Stack Overflow
OpenStreetMap

Markdown– struktura dokumentu

Nagłówek pierszego poziomu

Nagłówek pierwszego poziomu
===========================

lub

# Nagłówek pierwszego poziomu

Nagłowek drugiego poziomu

Nagłówek drugiego poziomu
-------------------------

lub

## Nagłówek drugiego poziomu

Nagłówek trzeciego poziomu

### Nagłówek trzeciego poziomu

Nowy akapit

Nowy akapit tworzy się wstawiając pustą (jedną lub więcej) linię.

Markdown – formatowanie tekstu

Podkreślanie tekstu (kursywa i pogrubienie)

*tekst pisany kursywą*
_tekst pisany kursywą_
**tekst pogrubiony**
__tekst pogrubiony__

Przekreślenie tekstu

~~tekst przekreślony~~

Markdown – elementy blokowe

Cytaty

> treść cytatu

Listy

* element listy wypunktowanej
1. element listy numerowanej

Linia prosta

***
---
* * *

Umieszczanie kodu

w linii ` kod `
jako osobny akapit ```kod```

Markdown – hiperlinki

Odnośniki do stron www

[Strona WMI](https://www.wmi.amu.edu.pl/pl/)

Styl referencyjny

[Wydział Matematyki i Informatyki][wmi]

[Uniwersytet im. Adama Mickiewicza w Poznaniu][uam]

[wmi]: https://www.wmi.amu.edu.pl/pl/        "WMI"
[uam]: https://amu.edu.pl/  "UAM"

w efekcie wyprodukuje

Wydział Matematyki i Informatyki

Uniwersytet im. Adama Mickiewicza w Poznaniu

Markdown – umieszczanie grafiki

Umieszczanie grafiki w tekście

![alternatywny tekst](/wzgledna_sciezka_do_pliku/img.jpg
"Opcjonalny tytuł")

Markdown – tabele

Tworzenie tabel

Tabele nie są częścią standardowej specyfikacji Markdowna, ale na wielu platformach można ich używać (np. GitHub, RevealJs).

Przykładowa tabela – kod źródłowy

| Tabele        | są                  | fajne |
| ------------- |:-------------------:| -----:|
| kol 3 jest    | wyrównana do prawej | $1600 |
| kol 2 jest    | wycentrowana        |   $12 |
| kol 1 jest    | wyrównana do lewej  |    $1 |

Przykładowa tabela – wynik

Tabele	są	fajne
kol 3 jest	wyrównana do prawej	$1600
kol 2 jest	wycentrowana	$12
kol 1 jest	wyrównana do lewej	$1

Pandoc

Czym jest Pandoc?

Pandoc jest programem do konwersji (zmiany) jednego formatu pliku do innego.

Jak używać programu?

Pandoc jest programem obsługiwanym z linii komend.

Jakie formaty obsługuje Pandoc?

tex
docx
html
epub
i dużo więcej!

Markdown i Pandoc

Przykładowy plik

---
title:  'Przykładowa prezentacja'
author: 'Paweł Mleczko'
date:   2018-01-17
lang:   'pl'
---
# Tytuł rozdziału

## Pierwszy slajd
- *treść* pierwszego **slajdu**
- trochę matematyki
$$\sum_{n=1}^\infty a_n$$

## Drugi slajd
Formatowanie *tekstu* jest bardzo **proste**!

Generowanie pliku wynikowego (html)

pandoc file1.md -s --mathjax -o file1-html.html

Plik html

Generowanie pliku wynikowego (revealjs)

pandoc -t revealjs -V revealjs-url='https://static.wmi.amu.edu.pl/reveal.js/3.5.0'
--mathjax --standalone -o file1-revealjs.html file1.md

Plik html z biblioteką revealjs

Generowanie pliku wynikowego (beamer)

pandoc --to=beamer --standalone --output=file1-beamer.tex file1.md

Plik tex

Plik pdf (po kompilacji PdfLaTeX-em)

Generowanie pliku wynikowego (docx)

pandoc -o file1-docx.docx file1.md

Plik docx