md2tufte/en-example.markdown

:::::::::::::::::::::::::::::::::::::::::::::::::::::::::: TITLE : md2tufte SUBTITLE : Exemplary overview document ~·~ v2021-09-10 AUTHOR : relikd TOC : @@@ Features Requirements Usage @@@ PDF-URL: ../en-example.pdf ::::::::::::::::::::::::::::::::::::::::::::::::::::::::::

This document is an exemplary usage of this tool. Of course it will look better with actual documents when the content is longer and the lines break more nicely.

Features

This document@=latex= A HTML version of this document using a responsive layout for small screens is available at https://relikd.github.io/md2tufte/bin/en-example.html ==@ was created with md2tufte – a tool which takes a markdown file as input and returns html and pdf as output. It supports the usual markdown syntax and is augmented with a substitution header. To place something in the margin, use the @ == syntax.@== multi line, super long name desc with various other words than these mere few you saw in the beginning! ==@

For further examples, refer to the README file. You can use in-document references.@== e.,g., see section Requirements. ==@

As you see, you can put about anything in the margin. If you want to control that something should be only visible in the pdf version of the document but not in the html version, use the @ =latex= syntax. Currently there is no inverse, i.,e., @ =html= will not work.

Requirements

@== You can use margin images!==@

• pandoc
• Python 3
• xelatex

Usage

make all

builds all *.markdown files in the directory.

make file.html

just build the html version of a specific file.

make file.pdf

equivalently build pdf.

make file.tex

build the intermediate file only.