Discover how to write manuscripts in Markdown and translate them with Pandoc into different output formats. You’ll use Markdown to annotate text formatting information with a strong focus on semantic information: you can annotate your text with information about where chapters and sections start, but not how chapter and heading captions should be formatted. As a result, you’ll decouple the structure of a text from how it is visualized and make it easier for you to produce different kinds of output. The same text can easily be formatted as HTML, PDF, or Word documents, with various visual styles, by tools that understand the markup annotations.
Finally, you’ll learn to use Pandoc, a tool for translating between different markup languages, such as LaTeX, HTML, and Markdown. This book will not describe all the functionality that Pandoc provides, but will teach you how to translate Markdown documents, how to customize your documents using templates, and how to extend Pandoc’s functionality using filters. If that is something you are interested in, Introducing Markdown and Pandoc will get you started.
With this set of skills you’ll be able to write more efficiently without worrying about needless formatting and other distractions.
What You Will Learn
- Why and how to use Markdown and Pandoc
- Write Markdown
- Use extensions available in Pandoc and Markdown
- Write math and code blocks
- Use templates and produce documents
Who This Book Is For
Programmers and problem solvers looking for technical documentation solutions.
| About the Author |
|
vii | |
| About the Technical Reviewer |
|
ix | |
|
Chapter 1 The Beginner's Guide to Markdown and Pandoc |
|
|
1 | (4) |
|
Chapter 2 Why Use Markdown and Pandoc |
|
|
5 | (8) |
|
Separating Semantics from Formatting |
|
|
6 | (2) |
|
|
|
8 | (1) |
|
|
|
9 | (2) |
|
|
|
11 | (2) |
|
Chapter 3 Writing Markdown |
|
|
13 | (10) |
|
|
|
13 | (1) |
|
|
|
14 | (1) |
|
|
|
15 | (2) |
|
|
|
17 | (1) |
|
|
|
18 | (1) |
|
|
|
18 | (2) |
|
|
|
20 | (1) |
|
|
|
20 | (3) |
|
|
|
21 | (1) |
|
|
|
21 | (1) |
|
|
|
21 | (1) |
|
|
|
21 | (1) |
|
|
|
22 | (1) |
|
|
|
22 | (1) |
|
Chapter 4 Pandoc Markdown Extensions |
|
|
23 | (12) |
|
|
|
23 | (4) |
|
|
|
27 | (5) |
|
|
|
32 | (1) |
|
|
|
33 | (1) |
|
|
|
34 | (1) |
|
|
|
34 | (1) |
|
|
|
34 | (1) |
|
|
|
34 | (1) |
|
Chapter 5 Translating Documents |
|
|
35 | (12) |
|
Formatting a Markdown Document with Pandoc |
|
|
35 | (5) |
|
Frequently Useful Options |
|
|
40 | (2) |
|
|
|
40 | (1) |
|
|
|
41 | (1) |
|
|
|
41 | (1) |
|
|
|
42 | (1) |
|
|
|
42 | (5) |
|
Chapter 6 Math and Computer Programming Languages |
|
|
47 | (10) |
|
|
|
47 | (3) |
|
|
|
50 | (2) |
|
|
|
52 | (2) |
|
Syntax Highlighting Styles |
|
|
54 | (1) |
|
|
|
55 | (2) |
|
|
|
55 | (1) |
|
|
|
55 | (1) |
|
|
|
55 | (2) |
|
Chapter 7 Cross-referencing |
|
|
57 | (10) |
|
|
|
58 | (3) |
|
|
|
61 | (2) |
|
Referencing Figures, Tables, and Equations |
|
|
63 | (1) |
|
|
|
64 | (2) |
|
|
|
66 | (1) |
|
|
|
66 | (1) |
|
Figures, Tables, and Equations |
|
|
66 | (1) |
|
|
|
66 | (1) |
|
|
|
67 | (6) |
|
|
|
68 | (5) |
|
Chapter 9 Using Templates |
|
|
73 | (18) |
|
Writing Your Own Templates |
|
|
77 | (12) |
|
|
|
78 | (11) |
|
|
|
89 | (2) |
|
|
|
91 | (8) |
|
|
|
92 | (6) |
|
|
|
92 | (2) |
|
|
|
94 | (2) |
|
|
|
96 | (2) |
|
|
|
98 | (1) |
|
|
|
99 | (34) |
|
|
|
104 | (2) |
|
Conditional Inclusion of Exercise Solutions |
|
|
106 | (6) |
|
Conditional Inclusions Based on Format |
|
|
112 | (3) |
|
|
|
115 | (4) |
|
|
|
119 | (11) |
|
|
|
130 | (3) |
|
|
|
130 | (1) |
|
|
|
130 | (1) |
|
|
|
131 | (1) |
|
|
|
131 | (2) |
|
|
|
133 | (2) |
| Index |
|
135 | |
Thomas Mailund is an associate professor in bioinformatics at Aarhus University, Denmark. He has a background in math and computer science, including experience programming and teaching in the C and R programming languages. For the last decade, his main focus has been on genetics and evolutionary studies, particularly comparative genomics, speciation, and gene flow between emerging species.
