{"id":18904375,"url":"https://github.com/relikd/md2tufte","last_synced_at":"2026-05-06T11:38:01.857Z","repository":{"id":144637300,"uuid":"382897444","full_name":"relikd/md2tufte","owner":"relikd","description":"A custom markdown to html + pdf compiler; based on Tufte CSS.","archived":false,"fork":false,"pushed_at":"2022-03-15T11:48:21.000Z","size":4260,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-05-31T23:11:22.265Z","etag":null,"topics":["html","latex","markdown","pandoc","pdf","pdf-generation","tex","tufte","tufte-css"],"latest_commit_sha":null,"homepage":"https://relikd.github.io/md2tufte/bin/en-example.html","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/relikd.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-07-04T16:23:12.000Z","updated_at":"2023-07-25T14:24:48.000Z","dependencies_parsed_at":null,"dependency_job_id":"b1113126-8eab-4356-8487-6c7d5d310c5e","html_url":"https://github.com/relikd/md2tufte","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/relikd/md2tufte","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relikd%2Fmd2tufte","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relikd%2Fmd2tufte/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relikd%2Fmd2tufte/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relikd%2Fmd2tufte/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/relikd","download_url":"https://codeload.github.com/relikd/md2tufte/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/relikd%2Fmd2tufte/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32692591,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-06T08:33:17.875Z","status":"ssl_error","status_checked_at":"2026-05-06T08:33:17.221Z","response_time":117,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["html","latex","markdown","pandoc","pdf","pdf-generation","tex","tufte","tufte-css"],"created_at":"2024-11-08T09:08:12.509Z","updated_at":"2026-05-06T11:38:01.840Z","avatar_url":"https://github.com/relikd.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# md2tufte\n\nA custom markdown to html + pdf compiler; based on Tufte CSS.\n\nTo build all files run `make all` (or `make file.html`, `make file.tex`, `make file.pdf` respectively). Refer to the Makefile to learn what it does.\n\nLook at the [example pdf](https://relikd.github.io/md2tufte/en-example.pdf) and [example html](https://relikd.github.io/md2tufte/bin/en-example.html) output built from the [markdown input](en-example.markdown) file.\n\n\n## Requirements\n\nYou'll need:\n\n- [pandoc](https://pandoc.org/installing.html)\n- [Python 3](https://www.python.org/download/releases/3.0/)\n- xelatex\n\nIncluded in the package:\n\n- [Tufte CSS](https://edwardtufte.github.io/tufte-css/)\n- Font [Cochineal](https://www.ctan.org/pkg/cochineal), by \tMichael Sharpe\n- Font [Roboto](https://github.com/googlefonts/roboto), by Christian Robertson\n- Font [Iosevka](https://github.com/be5invis/Iosevka), by Belleve Invis\n- Font [Piazzolla](https://github.com/huertatipografica/piazzolla), by Juan Pablo del Peral\n\n\n## Usage\n\nThe format is mostly markdown, except for these modifications:\n\n- Whitespace\n  - Use `\\,` to insert a non-breaking thin-space.\n  - Use `\\~` or the actual character to insert a normal-width non-breaking space (unicode nbsp in macOS: `Alt + Space`, Linux: `???`, Windows: `???`).\n  - Use `\\newpage` to start a new page in latex (which is ignored in html)\n\n- Use `@== CONTENT ==@` to create a margin element; Text or image or whatever.\n  - multi-line content allowed.\n  - the prefix `@=latex=` will display its content in pdf only. There is no html-prefix equivalent.\n\n- Use `####` to create paragraphs and `#####` for paragraph-like sections. The latter are displayed in the margin. Like an index for quick reference. In mobile html they are normal `h5` headings.\n  - Of course `#`, `##`, and `###` translate to `h1` to `h3` headings.\n\n- You can add a reference-id to a title by adding `{#label}` after the title, e.g., `## Title {#title}`\n  - other than that, all titles have implicit labels where spaces are replaced with dashes `My Title` becomes `my-title`\n  - btw., you can also add classes this way `{.fullwidth}`\n  - Use normal markdown syntax `[name](#ref)` to link to a section (works in both, html and latex)\n\n- Use `\u003cdl\u003e\u003cdt\u003e\u003cdd\u003e` to create definition lists. This will be translated to a latex `\\begin{description}` environment.\n\n\n## Templating\n\n- The file prefix, e.g. `en`, is the template file identifier. This can be used for multi-language generation or different types of webpages.\n\n- The header always begins and ends with a line of at least five colons `:::::`\n  - Each line inside the header has the format `KEY: VALUE`\n  - Whitespace around the key and value is discarded\n  - Each key is replaced in the template file. The placeholder has the format `\u003c#_KEY_#\u003e`\n  - Don't use the `BODY` key, as it is reserved for the generated content\n  - No other lines (including blank lines) are allowed. Except multi-line variables.\n    - Each ML-variable begins with ` KEY : @@@ ` and ends with a line of just three at-signs (regex: `^@@@$`). No whitespace allowed.\n    - multi-line variables may contain a line of colons (the header terminator is ignored here)\n\n\n## Limitations\n\nThis script has not been tested on Linux or Windows. However, Linux should work fine ... in theory.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelikd%2Fmd2tufte","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frelikd%2Fmd2tufte","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frelikd%2Fmd2tufte/lists"}