summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/generic/markdown/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/generic/markdown/README.md')
-rw-r--r--Master/texmf-dist/doc/generic/markdown/README.md38
1 files changed, 33 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/generic/markdown/README.md b/Master/texmf-dist/doc/generic/markdown/README.md
index d29e20c8752..99ee0367e30 100644
--- a/Master/texmf-dist/doc/generic/markdown/README.md
+++ b/Master/texmf-dist/doc/generic/markdown/README.md
@@ -1,5 +1,6 @@
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]
@@ -14,10 +15,13 @@ 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"
+ [markdown]: https://daringfireball.net/projects/markdown/basics "Daring Fireball: Markdown Basics"
+
+ ![banner](banner.png "An example LaTeX document using the Markdown package")
Further information
-------------------
+
For further information, consult one of the following:
1. The [user manual][manual], which can be produced by interpreting the
@@ -40,7 +44,8 @@ For further information, consult one of the following:
- [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].
+ - [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].
[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"
@@ -49,10 +54,11 @@ For further information, consult one of the following:
[overleaf-5]: https://www.overleaf.com/latex/examples/writing-posters-with-markdown/jtbgmmgqrqmh "Writing Posters with Markdown"
[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/members/TUGboat/tb40-1/tb124novotny-markdown.pdf "Markdown 2.7.0: Towards lightweight markup in TeX"
+ [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"
- [10.5300/2016-1-4/78]: https://doi.org/10.5300/2016-1-4/78 "Rendering Markdown inside TeX Documents"
+ [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"
[install]: http://mirrors.ctan.org/macros/generic/markdown/markdown.html#installation "Markdown Package User Manual"
[liantze]: http://liantze.penguinattack.org/ "Rants from the Lab"
@@ -83,6 +89,7 @@ Acknowledgements
Contributing
------------
+
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
@@ -108,3 +115,24 @@ is provided by the [doc][] LaTeX package.
[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"
+
+Citing Markdown
+---------------
+
+When citing Markdown in academic papers and theses, please use the following
+BibTeX entry:
+
+```bib
+@article{novotny17markdown,
+ author = {V\'{i}t Novotn\'{y}},
+ year = {2017},
+ title = {Using {M}arkdown Inside {\TeX} Documents},
+ journal = {TUGboat},
+ volume = {38},
+ number = {2},
+ pages = {214--217},
+ issn = {0896-3207},
+ url = {https://tug.org/TUGboat/tb38-2/tb119novotny.pdf},
+ urldate = {2020-07-31},
+}
+```