Newer
Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
toc-title: Contents
lang: en
title: Pandoc Markdown
subtitle: A `VSCode` extension for wrinting Pandoc Markdown documents using Pandoc
author: Dr Taz
keywords: Markdown, Pandoc, VSCode
bibliography: "assets/MyLib.bib"
csl: "assets/journal-of-neurophysiology.csl"
fontsize: 11.5pt
mainfont: Palatino, Georgia, Times, Arial
---
### Abstract
`Pandoc Markdown` allows writing Markdown documents using Pandoc for both typesetting and real-time preview, with no third party renderers nor CSS files, just Pandoc. As a bonus, a curated *Article* CSS is provided, which allows producing documents inspired by those produced by the `article` LaTeX class. This extension requires Pandoc to be available from the command line.
## 1. Intro
Please see [Pandoc's Markdown] for detailed documentation about basic and extended Pandoc Markdown.
## 2 Pandoc Markdown
### 2.1 Code
Pre formatted:
~~~
Normal text
Pre formatted
~~~
Source code:
~~~python
# Python
import numpy as np
x = np.linspace(0,np.pi)
print("Hi from Python")
~~~
And:
~~~js
// javascript
const changeColor = (newColor) => {
const element = document.getElementById('message');
element.style.color = newColor;
}
~~~
### 2.2 Columns
Columns are specified as a `<div>` of class `.columns`, which contains another `<divs>` of `<.column>` class. `<divs>` are specified in Pandoc Markdown using at least three colons as `:::` . For example:
:::{[#label] .columns [attrs]}
:::{.column width="45%"}
First column contents
:::
:::{.column width="10%"}
:::
:::{.column width="45%"}
Second Column contents
:::
:::
Which produces something as:
:::{.columns}
:::{.column width="48%;font-style: italic"}
1st Column Lorem ipsum dolor sit amet, consectetur adipiscing elit
:::
:::{.column width="4%"}
:::
:::{.column width="48%;background-color:#eee"}
2nd Column, Lorem ipsum dolor sit amet, consectetur adipiscing elit
:::
:::
### 2.3 Tables
#### i. Simple
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua (see Table \ref{Table1}).
| Syntax | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |
Which renders as:
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
| Syntax | Description |
| --------- | ----------- |
| Header | Title |
| Paragraph | Text |
#### ii. Aligned
Column alignments are determined by the position of the header text relative to the dashed line below it
: Table 1.1: Simple table syntax.
Right Left Center Default
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
: Table 1.1: Simple table syntax.
Right Left Center Default
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
Tables using pipes:
: Table 2: Using pipes and colons
| Left | Centered | Right |
|:--------- |:--------:| -----------:|
| Header | Title | Here's this |
| Paragraph | Text | And more |
Which renders as:
: Table 2: Using pipes and colons
| Left | Centered | Right |
|:--------- |:--------:| -----------:|
| Header | Title | Here's this |
| Paragraph | Text | And more |
Or simply:
: Tabla 2.1: Pipe, simple
Fruit | Price ($) | Existence
-------|-----------:| :-------:
apple | 2.05 | 3 box
pear | 1.37 | 2 kg
: Tabla 2.1: Pipe, simple
Fruit | Price ($) | Existence
-------|-----------:| :-------:
apple | 2.05 | 3 box
pear | 1.37 | 2 kg
### 2.4 Small caps
To write small caps, use the smallcaps class:
~~~md
This is a [Small caps text]{.smallcaps} , got it?
~~~
This is a [Small caps text]{.smallcaps} , got it?
### 2.5 Figuras
#### i. Simple
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
~~~md
{#fig1}
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
{#fig1}
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
#### ii. With attributes
See [Fig. 2](#figattrs).
~~~md
{#figattrs width=40%}
~~~
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua (see [Fig Attrs](#figattrs)).
{#figattrs width=40%}
### 2.6 Aside figures and text
<aside>

</aside>
<aside>

</aside>
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Turpis cursus in hac habitasse platea dictumst quisque sagittis. In ornare quam viverra orci. Mauris rhoncus aenean vel elit. Fames ac turpis egestas maecenas pharetra convallis. Mauris nunc congue nisi vitae suscipit tellus mauris a diam.
<aside>
This text should be located as an `<aside>` insert (right side).
</aside>
<aside>
This text should be located as an `<aside>` insert (right side).
</aside>
Fames ac turpis egestas integer eget aliquet nibh praesent tristique. Laoreet suspendisse interdum consectetur libero id faucibus nisl tincidunt. Ornare aenean euismod elementum nisi quis. Ipsum dolor sit amet consectetur adipiscing elit ut. Vitae congue mauris rhoncus aenean vel elit scelerisque.
### 2.7 Math
Use one og the math rendering options, such as `--katex` , `--mathjax`, etc.
[]{#xfoo}
Dictumst ac turpis egestas integer dictumst quisque sit amet. A paraghrah. See [ec. 2](#ec-2)
The formula, $y=mx+c$, is displayed inline. Some symbols and equations (such as
$\sum{x}$ or $\frac{1}{2}$) are rescaled to prevent disruptions to the regular
line spacing.
For example: []{#ec-2}
$$ f(x) = \sum_{n=0}^{\infty} \frac {f^{(n)}(a)} {n!} (x-a)^n $$
where:
: $f^{(n)}(a)$ = the $k$-th derivative of $f$ evaluated at point $a$.
### 2.8 Definitions
**Term 1:**
: Definition 1
**Term 2:**
: Definition 2
**Term 1:**
: Definition 1
**Term 2:**
: Definition 2
### 2.9 Footnotes
Pandoc’s Markdown allows footnotes, using the following syntax:
Here is a footnote reference[^1], and another one [^longnote].
[^1]: Here is the footnote.
[^longnote]: Here's one with multiple blocks.
Here is a footnote reference[^1], and another one [^longnote] .
[^1]: Here is the footnote.
[^longnote]: Here's one with multiple blocks.
### 2.10 Citations
To cite a bibliographic item with an identifier foo [@hoffmann_platon_1951], use the syntax `[@foo]`. Normal citations should be included in square brackets, with semicolons separating distinct items:
Blah blah [doe99; smith2000; smith2004].
How this is rendered depends on the citation style [@temple_beginnings_1993]. In an author-date style. @temple_beginnings_1993 says good things.
Citation items may optionally include a prefix, a locator, and a suffix. In
Blah blah [see @doe99, pp. 33-35 and *passim*; @smith04, chap. 1].
The first item (`@doe99`) has prefix see, `locator pp. 33-35`, and suffix and *passim*. The second item (`@smith04`) has locator `chap. 1` and no prefix or suffix.
You can also write an author-in-text citation, by omitting the square brackets:
@smith04 says blah.
@smith04 [p. 33] says blah.
This [@hoffmann_platon_1951] will cause the author’s name to be rendered, followed by the bibliographical details. Use this form when you want to make the citation the subject of a sentence [@hoffmann_platon_1951;@temple_beginnings_1993].
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent quis tortor sit amet urna facilisis sollicitudin. Ut efficitur, enim vitae sodales aliquet, odio dui consectetur nisl, quis facilisis mauris est ut odio. Proin convallis erat sit amet arcu pellentesque blandit. Aliquam at turpis vestibulum, iaculis nibh nec, eleifend ex. Vestibulum porta nec dolor ac porttitor. Nullam maximus vitae lacus ac hendrerit. Pellentesque aliquet, est nec finibus pharetra, nulla arcu malesuada orci, eget consequat lacus sapien eget libero. Phasellus dapibus turpis sed euismod sodales. Proin rhoncus odio non magna finibus, quis mollis enim lacinia. In hac habitasse platea dictumst. In eget neque blandit, dapibus lacus euismod, varius ligula. Praesent at dui ut eros gravida mollis. Ut viverra lorem risus.
Cras ut congue sem. Mauris ex nulla, dapibus eu varius et, commodo eget dolor. Nunc velit ligula, sagittis placerat feugiat a, tincidunt et purus. Quisque eu convallis massa. Curabitur in sollicitudin felis. Phasellus mattis tincidunt ultricies. Sed sodales semper lorem quis semper. Quisque sollicitudin cursus dolor, quis fringilla magna lacinia eu. Donec at sagittis metus. Ut et lectus justo. Vestibulum sollicitudin commodo iaculis. In in elit nunc. Ut eget laoreet lorem.
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent quis tortor sit amet urna facilisis sollicitudin. Ut efficitur, enim vitae sodales aliquet, odio dui consectetur nisl, quis facilisis mauris est ut odio. Proin convallis erat sit amet arcu pellentesque blandit. Aliquam at turpis vestibulum, iaculis nibh nec, eleifend ex. Vestibulum porta nec dolor ac porttitor. Nullam maximus vitae lacus ac hendrerit. Pellentesque aliquet, est nec finibus pharetra, nulla arcu malesuada orci, eget consequat lacus sapien eget libero. Phasellus dapibus turpis sed euismod sodales. Proin rhoncus odio non magna finibus, quis mollis enim lacinia. In hac habitasse platea dictumst. In eget neque blandit, dapibus lacus euismod, varius ligula. Praesent at dui ut eros gravida mollis. Ut viverra lorem risus.
Cras ut congue sem. Mauris ex nulla, dapibus eu varius et, commodo eget dolor. Nunc velit ligula, sagittis placerat feugiat a, tincidunt et purus. Quisque eu convallis massa. Curabitur in sollicitudin felis. Phasellus mattis tincidunt ultricies. Sed sodales semper lorem quis semper. Quisque sollicitudin cursus dolor, quis fringilla magna lacinia eu. Donec at sagittis metus. Ut et lectus justo. Vestibulum sollicitudin commodo iaculis. In in elit nunc. Ut eget laoreet lorem.
## References
[Pandoc]: https://pandoc.org/
[VSCode]: https://code.visualstudio.com
[markdown-it]: https://github.com/markdown-it/markdown-it
[Pandoc's Markdown]: https://pandoc.org/MANUAL.html#pandocs-markdown