akshat-ja/pandoc-goodies

A tresure-box of resources for pandoc, pp and Texts word processor.

Pandoc-Goodies

pandoc v2.0.5 | PP v2.1.5

A tresure-box of resources for pandoc, pp and the Texts word processor.

• https://github.com/tajmone/pandoc-goodies

Copyright © Tristano Ajmone 2017, MIT License.

The project is still WIP and in its early stages, but a pandoc html5 template is ready for use, along with a growing pp-macros library.

PANDOC 2 READY — All resources have been finally ported to work with the new pandoc v2.x release! Copies of some resources for pandoc v1 will be kept in “pandoc_v1” subfolders, for projects which might still need them, but they will no longer be updated.

---

Table of Contents

• Available Goodies
  • Pandoc HTML5 Templates
  • PP Macros
  • Skylighting CSS
  • Skylighting Themes
• Related Projects
• Third Party Code Credits
• Notes About Pandoc License
  • GPLv2 vs BSD-3

---

Available Goodies

Pandoc HTML5 Templates

Currently, the only template current available is:

• GitHub Pandoc HTML5 Template
• HTML Preview: Local | via HTMLPreview.GitHub.io

PP Macros

The pp-macros section is an ongoing effort to create a collection of pp macros to extend pandoc’s markdown workflow by providing means to use GFM task lists in markdown source file, external syntax highlighters, and many more features.

• The PP-Macros Library

About PP: PP is a text preprocessor designed for Pandoc (and more generally Markdown and reStructuredText). It’s cross-platform and available as a single standalone binary file:

• https://github.com/CDSoft/pp
• http://cdsoft.fr/pp/
• https://github.com/tajmone/markdown-guide/tree/master/pp

Skylighting CSS

The skylighting CSS section contains resources for styling code blocks in HTML format.

• Skylighting CSS

Skylighting Themes

The skylighting themes section contains resources for customizing syntax highlighting styles via KDE theme files (JSON).

• Skylighting JSON Themes

Related Projects

Here is a list of other pandoc-related projects which you might be interested in visiting:

• GitHub Pages Themes Magick — Create a repo's GitHub Pages website from its README.md file via pandoc and pandoc templates (now supports pandoc v2).

Third Party Code Credits

The “Pandoc-Goodies” project reuses third party source code from the following projects:

• GitHub Markdown CSS — © Sindre Sorhus, MIT License.
• Primer CSS — © 2016 GitHub Inc., MIT License.

You’ll find more details and license information in the documentation of the subfolders.

Notes About Pandoc License

Some legal stuff you should be aware regarding the license terms governing pandoc and some of its built-in resources.

Pandoc is (c) 2006-2017 John MacFarlane, released under the GPL v2 (or greater) license.

The built-in styles (aka syntax themes) that pandoc injects into the final documents also fall under the same GPL v2 license as pandoc.

Pandoc’s built-in default templates are dual-licensed — under both the GPL (v2 or higher, same as pandoc) and the BSD 3-clause (“New” or “Revised”) license:

• https://github.com/jgm/pandoc-templates

You should be aware that the built-in syntax highlighting styles are not part of the templates, and therefore are not subject to dual-licensing. Styles are added at conversion time (for those format that support highlighting). Since pandoc’s default templates rely on the built-in styles, syntax highlighting might (depending on output format) automatically include into the final document a built-in style (“pygments”, by default). Since highligthing-styles are governed by the GPL v2 license (which demands same licensing), opting for the BSD 3-clause license might no longer apply to the final document if the template and the styling are woven together into a single file.

For a more detailed explanation regarding HTML templates and CSS styles, see:

• /skylighting-css/built-in-styles/README.md

GPLv2 vs BSD-3

A quick reference summary of both GPL v2 and BSD 3-clause licenses — Text excerpts and tables taken from choosealicense.com (license: CC BY 3.0):

• https://choosealicense.com/licenses/gpl-2.0/
• https://choosealicense.com/licenses/bsd-3-clause/

GNU General Public License v2.0

The GNU GPL is the most widely used free software license and has a strong copyleft requirement. When distributing derived works, the source code of the work must be made available under the same license. There are multiple variants of the GNU GPL, each with different requirements.

Permissions	Conditions	Limitations
✔ Commercial use	✔ Disclose source	✘ Liability
✔ Distribution	✔ License and copyright notice	✘ Warranty
✔ Modification	✔ Same license
✔ Private use	✔ State changes

BSD 3-clause “New” or “Revised” License

A permissive license similar to the BSD 2-Clause License, but with a 3rd clause that prohibits others from using the name of the project or its contributors to promote derived products without written consent.

Permissions	Conditions	Limitations
✔ Commercial use	✔ License and copyright notice	✘ Liability
✔ Distribution		✘ Warranty
✔ Modification
✔ Private use