{"id":13397054,"url":"https://github.com/jez/tufte-pandoc-css","last_synced_at":"2025-10-07T11:40:49.644Z","repository":{"id":12811245,"uuid":"72715945","full_name":"jez/tufte-pandoc-css","owner":"jez","description":"Starter files for using Pandoc Markdown with Tufte CSS","archived":false,"fork":false,"pushed_at":"2022-07-05T02:07:59.000Z","size":11633,"stargazers_count":328,"open_issues_count":1,"forks_count":33,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-05-19T13:08:59.653Z","etag":null,"topics":["markdown","pandoc","tufte-css","writing"],"latest_commit_sha":null,"homepage":"https://jez.io/tufte-pandoc-css/","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jez.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-11-03T06:34:45.000Z","updated_at":"2025-04-26T03:23:04.000Z","dependencies_parsed_at":"2022-09-20T20:01:27.605Z","dependency_job_id":null,"html_url":"https://github.com/jez/tufte-pandoc-css","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/jez/tufte-pandoc-css","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jez%2Ftufte-pandoc-css","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jez%2Ftufte-pandoc-css/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jez%2Ftufte-pandoc-css/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jez%2Ftufte-pandoc-css/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jez","download_url":"https://codeload.github.com/jez/tufte-pandoc-css/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jez%2Ftufte-pandoc-css/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278767557,"owners_count":26042410,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["markdown","pandoc","tufte-css","writing"],"created_at":"2024-07-30T18:01:10.271Z","updated_at":"2025-10-07T11:40:49.598Z","avatar_url":"https://github.com/jez.png","language":"CSS","funding_links":[],"categories":["CSS"],"sub_categories":[],"readme":"# Tufte Pandoc CSS\n\n\u003e Starter files for using Pandoc Markdown with Tufte CSS\n\nThis project aims to provide a standard set of project starter files for working\nwith [Pandoc] and [Tufte CSS]. It features:\n\n- extra CSS styles for things like tables and syntax highlighted code\n- tweaks to the CSS to get HTML produced by Pandoc to play nicely with Tufte CSS\n- an optional Solarized light color scheme for code blocks\n- a modular separation of these components--you can select which you want\n- an HTML5 template file that sets up the document the way Tufte CSS expects\n- support for lots of Pandoc markdown features, including\n  - footnotes as side notes\n  - footnotes as margin notes\n  - metadata like `title`, `subtitle`, `date`, and `author`\n  - LaTeX using MathJax or KaTeX\n\nApart from projects like Tufte CSS \u0026 Pandoc, the main project that enables this\nproject is [`pandoc-sidenote`], a project which converts Pandoc Markdown-style\nfootnotes (`[^1]`) into side notes.\n\n\u003e ### Looking to use this with Jekyll?\n\u003e\n\u003e You might be interested in [Tufte Pandoc Jekyll], which wraps the files\n\u003e distributed here into a Jekyll gem-based theme.\n\u003e\n\u003e ### Looking for the same features, but a different look?\n\u003e\n\u003e You might be interested in [Pandoc Markdown CSS Theme], a theme with much of\n\u003e the same features as this theme, but with a more easily customizable look.\n\n\u003c!-- START doctoc generated TOC please keep comment here to allow auto update --\u003e\n\u003c!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --\u003e\n## Table of Contents\n\n- [Background](#background)\n- [Installation](#installation)\n- [Usage](#usage)\n- [License](#license)\n\n\u003c!-- END doctoc generated TOC please keep comment here to allow auto update --\u003e\n\n\n## Background\n\nIf you haven't already, I encourage you to explore the projects that have been\nbuilt on top of here:\n\n- [Pandoc] - a universal document converter\n- [Tufte CSS] - style your webpage like Edward Tufte's handouts\n- [`pandoc-sidenote`] - convert Pandoc Markdown-style footnotes into sidenotes\n\n\n## Installation\n\n\u003e ### Dependencies\n\u003e\n\u003e This project is always tested relative to:\n\u003e\n\u003e - the most recent `master` commit of [`tufte-css`].\n\u003e - the latest release version of pandoc\n\u003e\n\u003e In particular, you'll need at least Pandoc version 2.0.\n\nThis project is meant to be a set of *starter* files for your next project. What\nthat ultimately means is that you should use these files however your heart sees\nfit. In practice, here are some tips for some things you may want to do to get\nset up.\n\nFirst, install `pandoc-sidenote` to your PATH.\n\n- This lets `pandoc` compile footnotes into sidenotes.\n- Instructions are on the [`pandoc-sidenote`] homepage.\n\nSecond, download `tufte.css` and the `et-book/` font folder.\n\n- Head over to [`tufte-css`] to download these.\n- You should be able to work with any version of Tufte CSS, assuming things\n  haven't changed too much.\n- If things don't seem to be working, try using the version stashed in the\n  `tufte-css/` folder in this repo (it's a submodule).\n\nThird, there are a number of static files you can download and place where you\nsee fit:\n\n- `tufte.html5`\n  - This is an HTML5 compatible template for use with Pandoc's `--template`\n    flag.\n  - It sets up the document structure in a way Tufte CSS expects.\n- `pandoc.css`\n  - This CSS file has styles for things like sections, author \u0026 date\n    information, highlighted code blocks, and tables.\n- `pandoc-solarized.css` (optional)\n  - This sets up highlighted code blocks to use the Solarized Light color theme\n- `tufte-extra.css` (optional)\n  - This makes some \"personal preference\" tweaks to Tufte CSS. It is NOT\n    required.\n\nFinally, you'll want the `Makefile`.\n\n- The Makefile usage is explained below.\n\n\n## Usage\n\nThe best way to learn to use this project is to read the documentation--both\nonline and in the source code. You'll probably want to look through things in\nthis order\n\n1. The [re-implementation of the Tufte CSS][tufte-md] homepage in Pandoc Markdown\n  - Remember to read the [source][tufte-md-src]!\n1. The [Tufte Pandoc CSS homepage], which documents the additional features\n   specific to this project.\n  - Remember to read the [source][homepage-src]!\n1. The included [Makefile], which compiles `*.md` files into `*.html` files\n   using `pandoc` with the correct options.\n1. The [Pandoc] homepage. Not everything you see here will work with this\n   project, but if you think something should work that doesn't, open an issue.\n   - You'll probably want to just skim this... it's lengthy!\n\nOnce you have an understanding of what Markdown features are available, you can\nuse the Makefile to compile your Markdown files.\n\nFor example, this is how we build the homepage for this site:\n\n```\nmake docs/index.md\n```\n\nand here's how we build all the site files:\n\n```\nmake docs\nmake\n```\n\nAssuming you've laid out your directory identically to this repo, you can pass\nthe name of any `*.md` file to convert it into an appropriately named `*.html`\nfile.\n\n```\nmake my-pandoc-markdown-file.md\n```\n\n\n## License\n\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://jez.io/MIT-LICENSE.txt)\n\n\n[Pandoc]: http://pandoc.org\n[Tufte CSS]: https://edwardtufte.github.io/tufte-css/\n[`tufte-css`]: https://github.com/edwardtufte/tufte-css\n[`pandoc-sidenote`]: https://github.com/jez/pandoc-sidenote\n[tufte-md]: https://jez.io/tufte-pandoc-css/tufte-md/\n[Tufte Pandoc CSS homepage]: https://jez.io/tufte-pandoc-css/\n[Tufte Pandoc Jekyll]: https://github.com/jez/tufte-pandoc-jekyll\n[Pandoc Markdown CSS Theme]: https://github.com/jez/pandoc-markdown-css-theme\n[tufte-md-src]: docs/tufte-md/index.md\n[homepage-src]: docs/index.md\n[`Makefile`]: Makefile\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjez%2Ftufte-pandoc-css","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjez%2Ftufte-pandoc-css","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjez%2Ftufte-pandoc-css/lists"}