summaryrefslogtreecommitdiff
path: root/macros/generic/markdown/markdown.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-10-02 03:03:32 +0000
committerNorbert Preining <norbert@preining.info>2021-10-02 03:03:32 +0000
commitac5a96ddb02c62d71eb214ed35e3be9a154d991f (patch)
treecdf35312568ce6b2b69e7374745ddafdd3e3c66b /macros/generic/markdown/markdown.md
parent569e4d488d3398f8ed12807dd67e2b301b7447d5 (diff)
CTAN sync 202110020303
Diffstat (limited to 'macros/generic/markdown/markdown.md')
-rw-r--r--macros/generic/markdown/markdown.md64
1 files changed, 38 insertions, 26 deletions
diff --git a/macros/generic/markdown/markdown.md b/macros/generic/markdown/markdown.md
index dcded9f944..9488ded486 100644
--- a/macros/generic/markdown/markdown.md
+++ b/macros/generic/markdown/markdown.md
@@ -2,7 +2,7 @@
---
title: Markdown Package User Manual
author: Vít Novotný
-date: v\markdownVersion{} (\markdownLastModified{})
+date: \markdownVersion{} (\markdownLastModified{})
---
@@ -16,7 +16,7 @@ functionality is provided both as a Lua module and as plain \TeX{}, \LaTeX{}, an
containing markdown markup. Unlike other convertors, the Markdown package
does not require any external programs, and makes it easy to redefine how each
and every markdown element is rendered. Creative abuse of the markdown
-syntax is encouraged. ;-)
+syntax is encouraged. 😉
[markdown]: https://daringfireball.net/projects/markdown/basics
(Daring Fireball: Markdown Basics)
@@ -36,36 +36,38 @@ documentation][techdoc].
Requirements
------------
-The package requires a working \TeX{} distribution. [\TeX{} Live][tl] ≥ 2013 is
-known to work and so are recent installation of [Mik\TeX{}][mik]. If you are
-using a minimal installation of a \TeX{} distribution, please consult the
-[technical documentation][techdoc] for a detailed list of required packages.
+The package requires either [our official Docker image][docker], which contains
+the latest development version of the Markdown package, or a \TeX{}
+distribution: [\TeX{} Live][tl] ≥ 2018 is known to work with the current
+version of the Markdown package and so are recent versions of [Mik\TeX{}][mik].
+If you are using an older, incomplete, or atypical \TeX{} distribution, please
+consult the [technical documentation][techdoc] for a detailed list of
+requirements.
+ [docker]: https://hub.docker.com/r/witiko/markdown/tags (witiko/markdown - Docker Image)
[tl]: https://www.tug.org/texlive/ (TeX Live - TeX Users Group)
[mik]: https://miktex.org/ (Home - MiKTeXorg)
Installation
------------
-The package comes pre-installed with [\TeX{} Live][tl] ≥ 2016 and with recent
-installations of [MikTeX][mik]. Unless you explicitly wish to use the latest
-version of the package, you are encouraged to skip this step.
+If Markdown is not included in your \TeX{} distribution, you will need to
+install it.
-To install the package, first download the package from the repository
-using Git:
+First, download the package from the repository using Git:
``` sh
git clone https://github.com/witiko/markdown
``````
-Next, enter the directory named `markdown` and interpret the file named
-`markdown.ins` file using a Unicode-aware \TeX{} engine, such as XeTeX or
-LuaTeX:
+Next, enter the directory named `markdown` and run the `make base` command using
+GNU Make:
``` sh
cd markdown
-luatex markdown.ins
+make base
``````
This should produce the following files:
* `markdown.lua`, the Lua module,
+ * `libraries/markdown-tinyyaml.lua`, an external library for reading \acro{yaml},
* `markdown-cli.lua`, the Lua command-line interface,
* `markdown.tex`, the plain \TeX{} macro package,
* `markdown.sty`, the \LaTeX{} package,
@@ -80,16 +82,17 @@ To perform a local installation, place the above files into your \TeX{}
directory structure. This is generally where the individual files should be
placed:
- * `<TEXMF>/tex/luatex/markdown/markdown.lua`
- * `<TEXMF>/scripts/markdown/markdown-cli.lua`
- * `<TEXMF>/tex/generic/markdown/markdown.tex`
- * `<TEXMF>/tex/latex/markdown/markdown.sty`
- * `<TEXMF>/tex/latex/markdown/markdownthemewitiko_dot.sty`
- * `<TEXMF>/tex/latex/markdown/markdownthemewitiko_graphicx_http.sty`
- * `<TEXMF>/tex/latex/markdown/markdownthemewitiko_tilde.sty`
- * `<TEXMF>/tex/context/third/markdown/t-markdown.tex`
-
-where `<TEXMF>` corresponds to a root of your \TeX{} distribution, such as
+ * `⟨TEXMF⟩/tex/luatex/markdown/markdown.lua`
+ * `⟨TEXMF⟩/tex/luatex/markdown/markdown-tinyyaml.lua`
+ * `⟨TEXMF⟩/scripts/markdown/markdown-cli.lua`
+ * `⟨TEXMF⟩/tex/generic/markdown/markdown.tex`
+ * `⟨TEXMF⟩/tex/latex/markdown/markdown.sty`
+ * `⟨TEXMF⟩/tex/latex/markdown/markdownthemewitiko_dot.sty`
+ * `⟨TEXMF⟩/tex/latex/markdown/markdownthemewitiko_graphicx_http.sty`
+ * `⟨TEXMF⟩/tex/latex/markdown/markdownthemewitiko_tilde.sty`
+ * `⟨TEXMF⟩/tex/context/third/markdown/t-markdown.tex`
+
+where `⟨TEXMF⟩` corresponds to a root of your \TeX{} distribution, such as
`/usr/share/texmf` and `~/texmf` on UN\*X systems or
`C:\Users\`\meta{Your username}`\texmf` on Windows systems. When in doubt,
consult the manual of your \TeX{} distribution.
@@ -113,6 +116,15 @@ In this section, we will take the necessary steps to typeset our first markdown
document in \TeX{}. This will serve as our first hands-on experience with the
package and also as a reassurance that the package has been correctly installed.
+If you are using [our official Docker image][docker], you need to prefix all
+commands in this section with `docker run --rm -v "$PWD"/workdir:/workdir -w
+/workdir witiko/markdown`. For example, instead of `luatex document.tex`, you
+would execute the following command:
+``` sh
+docker run --rm -v "$PWD"/workdir:/workdir -w /workdir witiko/markdown \
+ luatex document.tex
+``````
+
### Using Lua
Using a text editor, create a text document named `document.tex` with the
@@ -281,7 +293,7 @@ In this section, I will describe the individual parts of the Markdown package.
Each part will be shown by example, leaving the implementation details to the
[technical documentation][techdoc].
- [techdoc]: http://mirrors.ctan.org/macros/generic/markdown/markdown.pdf
+ [techdoc]: https://mirrors.ctan.org/macros/generic/markdown/markdown.pdf
(A Markdown Interpreter for \TeX{})
/markdown-interfaces.md