summaryrefslogtreecommitdiff
path: root/macros/generic/markdown/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2021-08-08 03:01:03 +0000
committerNorbert Preining <norbert@preining.info>2021-08-08 03:01:03 +0000
commited204b296810be74994f70f76b7f5b849f6e9ecb (patch)
treef39bb9d2abbf54d1fa1a585d245a0942c77e2f05 /macros/generic/markdown/README.md
parent5991e0faa2ab9a1b9bdb72d6399cff4444b02f35 (diff)
CTAN sync 202108080301
Diffstat (limited to 'macros/generic/markdown/README.md')
-rw-r--r--macros/generic/markdown/README.md24
1 files changed, 16 insertions, 8 deletions
diff --git a/macros/generic/markdown/README.md b/macros/generic/markdown/README.md
index 99ee0367e3..62d857935a 100644
--- a/macros/generic/markdown/README.md
+++ b/macros/generic/markdown/README.md
@@ -2,10 +2,10 @@ Markdown
========
[![release](https://img.shields.io/github/release/witiko/markdown.svg)][release]
-[![CircleCI](https://circleci.com/gh/Witiko/markdown/tree/master.svg?style=shield)][CircleCI]
+[![ci](https://github.com/Witiko/markdown/workflows/Test/badge.svg)][ci]
- [CircleCI]: https://circleci.com/gh/Witiko/markdown/tree/master "CircleCI"
[release]: https://github.com/Witiko/markdown/releases/latest "Releases ยท Witiko/markdown"
+ [ci]: https://github.com/Witiko/markdown/actions "GitHub Actions"
The Markdown package converts [markdown][] markup to TeX commands. The
functionality is provided both as a Lua module, and as plain TeX, LaTeX, and
@@ -41,11 +41,14 @@ For further information, consult one of the following:
- [Writing Posters with Markdown][overleaf-5], and
- [Using Markdown in LaTeX documents][overleaf-6].
4. My journal articles published by [TUGboat][]:
- - [Using Markdown inside TeX documents][tb119], and
- - [Markdown 2.7.0: Towards lightweight markup in TeX][tb124].
+ - [Using Markdown inside TeX documents][tb119],
+ - [Markdown 2.7.0: Towards lightweight markup in TeX][tb124], and
+ - [Making Markdown into a Microwave Meal][tb129].
5. My journal articles published by [CSTUG][] (in Czech):
- [Rendering Markdown inside TeX Documents][10.5300/2016-1-4/78], and
- [Markdown 2.8.1: Boldly Unto the Throne of Lightweight Markup in TeX][10.5300/2020-1-2/48].
+6. My talks:
+ - [Five Years of Markdown in LaTeX: What, Why, How, and Whereto][pv212-fall2020] (in Czech).
[overleaf-1]: https://www.overleaf.com/learn/latex/Articles/How_to_write_in_Markdown_on_Overleaf "How to write in Markdown on Overleaf"
[overleaf-2]: https://www.overleaf.com/learn/latex/Articles/Markdown_into_LaTeX_with_Style "Markdown into LaTeX with Style"
@@ -56,10 +59,13 @@ For further information, consult one of the following:
[tb119]: https://www.tug.org/TUGboat/tb38-2/tb119novotny.pdf "Using Markdown inside TeX documents"
[tb124]: https://www.tug.org/TUGboat/tb40-1/tb124novotny-markdown.pdf "Markdown 2.7.0: Towards lightweight markup in TeX"
+ [tb129]: https://www.tug.org/TUGboat/tb41-3/tb129novotny-frozen.pdf "Making Markdown into a Microwave Meal"
[10.5300/2016-1-4/78]: https://bulletin.cstug.cz/pdf/2016-1-4.pdf#page=80 "Rendering Markdown inside TeX Documents"
[10.5300/2020-1-2/48]: https://bulletin.cstug.cz/pdf/2020-1-2.pdf#page=50 "Markdown 2.8.1: Boldly Unto the Throne of Lightweight Markup in TeX"
+ [pv212-fall2020]: https://is.muni.cz/el/fi/podzim2020/PV212/index.qwarp?prejit=5595952
+
[install]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#installation "Markdown Package User Manual"
[liantze]: http://liantze.penguinattack.org/ "Rants from the Lab"
[manual]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html "Markdown Package User Manual"
@@ -99,13 +105,15 @@ the documentation, are placed in the `Makefile` file for ease of maintenance.
When the file `markdown.ins` is interpreted using a Unicode-aware TeX engine,
such as XeTeX (`xetex markdown.ins`) or LuaTeX (`luatex markdown.ins`), several
-files are produced from the `markdown.dtx` document. In `markdown.dtx`, the
-boundaries between the produced files are marked up using an XML-like syntax
-provided by the [DocStrip][] plain TeX package.
+files are produced from the `markdown.dtx` document. The `make base` command
+is provided by `Makefile` for convenience. In `markdown.dtx`, the boundaries
+between the produced files are marked up using an XML-like syntax provided by
+the [DocStrip][] plain TeX package.
Running the [LaTeXMK][] tool on the `markdown.dtx` file
(`latexmk markdown.dtx`) after the Markdown package has been
-[installed][install] typesets the documentation. In `markdown.dtx`, the
+[installed][install] typesets the documentation. The `make markdown.pdf`
+command is provided by `Makefile` for convenience. In `markdown.dtx`, the
documentation is placed inside TeX comments and marked up using the
[ltxdockit][] LaTeX document class. Support for typesetting the documentation
is provided by the [doc][] LaTeX package.