summaryrefslogtreecommitdiff
path: root/macros/generic/markdown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'macros/generic/markdown/README.md')
-rw-r--r--macros/generic/markdown/README.md70
1 files changed, 40 insertions, 30 deletions
diff --git a/macros/generic/markdown/README.md b/macros/generic/markdown/README.md
index 44c963a2da..d29e20c875 100644
--- a/macros/generic/markdown/README.md
+++ b/macros/generic/markdown/README.md
@@ -10,8 +10,9 @@ The Markdown package converts [markdown][] markup to TeX commands. The
functionality is provided both as a Lua module, and as plain TeX, LaTeX, and
ConTeXt macro packages that can be used to directly typeset TeX documents
containing markdown markup. Unlike other convertors, the Markdown package
-makes it easy to redefine how each and every markdown element is rendered.
-Creative abuse of the markdown syntax is encouraged. 😉
+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. 😉
[markdown]: https://daringfireball.net/projects/markdown/basics/ "Daring Fireball: Markdown Basics"
@@ -38,6 +39,8 @@ For further information, consult one of the following:
4. My journal articles published by [TUGboat][]:
- [Using Markdown inside TeX documents][tb119], and
- [Markdown 2.7.0: Towards lightweight markup in TeX][tb124].
+5. My journal articles published by [CSTUG][] (in Czech):
+ - [Rendering Markdown inside TeX Documents][10.5300/2016-1-4/78].
[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"
@@ -47,7 +50,9 @@ For further information, consult one of the following:
[overleaf-6]: https://www.overleaf.com/latex/examples/using-markdown-in-latex-documents/whdrnpcpnwrm "Using Markdown in LaTeX documents"
[tb119]: https://www.tug.org/members/TUGboat/tb38-2/tb119novotny.pdf "Using Markdown inside TeX documents"
- [tb124]: https://www.tug.org/TUGboat/production/40-1/tb124novotny-markdown.pdf "Markdown 2.7.0: Towards lightweight markup in TeX"
+ [tb124]: https://www.tug.org/members/TUGboat/tb40-1/tb124novotny-markdown.pdf "Markdown 2.7.0: Towards lightweight markup in TeX"
+
+ [10.5300/2016-1-4/78]: https://doi.org/10.5300/2016-1-4/78 "Rendering Markdown inside TeX Documents"
[install]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#installation "Markdown Package User Manual"
[liantze]: http://liantze.penguinattack.org/ "Rants from the Lab"
@@ -55,18 +60,40 @@ For further information, consult one of the following:
[overleaf]: https://www.overleaf.com/ "Overleaf: Real-time Collaborative Writing and Publishing Tools with Integrated PDF Preview"
[techdoc]: http://mirrors.ctan.org/macros/generic/markdown/markdown.pdf "A Markdown Interpreter for TeX"
[tugboat]: https://www.tug.org/tugboat/ "TUGboat - Communications of the TeX Users Group"
+ [cstug]: https://www.cstug.cz/ "Československé sdružení uživatelů TeXu"
+
+Acknowledgements
+----------------
+
+| Logo | Acknowledgement |
+| ------------- | ------------- |
+| [<img width="150" src="https://www.fi.muni.cz/images/fi-logo.png">][fimu] | I gratefully acknowledge the funding from the [Faculty of Informatics][fimu] at the [Masaryk University][mu] in Brno, Czech Republic, for the development of the Markdown package. |
+| [<img width="150" src="https://cdn.overleaf.com/img/ol-brand/overleaf_og_logo.png">][overleaf] | Extensive user documentation for the Markdown package was kindly written by [Lian Tze Lim][liantze] and published by [Overleaf][]. |
+| [<img width="150" src="https://pbs.twimg.com/profile_images/1004769879319334912/6Bh1UthD.jpg">][omedym] | Support for content slicing (Lua options [`shiftHeadings`][option-shift-headings] and [`slice`][option-slice]) and pipe tables (Lua options [`pipeTables`][option-pipe-tables] and [`tableCaptions`][option-table-captions]) was graciously sponsored by [David Vins][dvins] and [Omedym][]. |
+
+ [dvins]: https://github.com/dvins "David Vins"
+ [fimu]: https://www.fi.muni.cz/index.html.en "Faculty of Informatics, Masaryk University"
+ [mu]: https://www.muni.cz/en "Masaryk University"
+ [Omedym]: https://www.omedym.com/ "Omedym"
+
+ [option-pipe-tables]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#pipe-tables "Markdown Package User Manual"
+ [option-shift-headings]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#option-shiftheadings "Markdown Package User Manual"
+ [option-slice]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#slice "Markdown Package User Manual"
+ [option-table-captions]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#option-tablecaptions "Markdown Package User Manual"
Contributing
------------
-Apart from the example markdown documents and tests, which are placed in the
-`examples/` and `tests/` directories, the complete source code and
-documentation of the package are placed in the `markdown.dtx` document
-following the literate programming paradigm.
+Apart from the example markdown documents, tests, and continuous integration,
+which are placed in the `examples/`, `tests/`, and `.circleci/` directories,
+the complete source code and documentation of the package are placed in the
+`markdown.dtx` document following the [literate programming][] paradigm.
+Some useful commands, such as building the release archives and typesetting
+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 a XML-like syntax
+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
@@ -76,25 +103,8 @@ 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.
- [doc]: https://ctan.org/pkg/doc "doc – Format LaTeX documentation"
- [DocStrip]: https://ctan.org/pkg/docstrip "docstrip – Remove comments from file"
- [LaTeXMK]: https://ctan.org/pkg/latexmk "latexmk – Fully automated LaTeX document generation"
- [ltxdockit]: https://ctan.org/pkg/ltxdockit "ltxdockit – Documentation support"
-
-Acknowledgements
-----------------
-I gratefully acknowledge the funding from the [Faculty of Informatics][fimu]
-at the [Masaryk University][mu] in Brno, Czech Republic, for the development of
-the Markdown package.
-
-Support for content slicing (Lua options `shiftHeadings` and `slice`) and pipe
-tables (Lua options `pipeTables` and `tableCaptions`) was graciously sponsored
-by [David Vins][dvins] and [Omedym][].
-
-Extensive user documentation of the Markdown package was kindly written by
-[Lian Tze Lim][liantze] and published by [Overleaf][].
-
- [dvins]: https://github.com/dvins "David Vins"
- [fimu]: https://www.fi.muni.cz/index.html.en "Faculty of Informatics, Masaryk University"
- [mu]: https://www.muni.cz/en "Masaryk University"
- [Omedym]: https://www.omedym.com/ "Omedym"
+ [doc]: https://ctan.org/pkg/doc "doc – Format LaTeX documentation"
+ [DocStrip]: https://ctan.org/pkg/docstrip "docstrip – Remove comments from file"
+ [LaTeXMK]: https://ctan.org/pkg/latexmk "latexmk – Fully automated LaTeX document generation"
+ [literate programming]: https://en.wikipedia.org/wiki/Literate_programming "Literate programming"
+ [ltxdockit]: https://ctan.org/pkg/ltxdockit "ltxdockit – Documentation support"