https://github.com/MasWag/pandoc-satysfi-template

A pandoc custom writer and template for SATySFi
https://github.com/MasWag/pandoc-satysfi-template

markdown-converter pandoc pandoc-writer satysfi satysfi-typesetting

Last synced: about 6 hours ago
JSON representation

A pandoc custom writer and template for SATySFi

• Host: GitHub
• URL: https://github.com/MasWag/pandoc-satysfi-template
• Owner: MasWag
• License: mit
• Created: 2019-03-02T03:39:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2021-05-25T08:07:23.000Z (over 3 years ago)
• Last Synced: 2024-11-08T01:09:05.894Z (5 days ago)
• Topics: markdown-converter, pandoc, pandoc-writer, satysfi, satysfi-typesetting
• Language: Lua
• Homepage:
• Size: 335 KB
• Stars: 9
• Watchers: 4
• Forks: 1
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-satysfi - pandoc-satysfi-template - A pandoc custom writer and template for SATySFi (Uncategorized / Uncategorized)

README

        
pandoc-satysfi-template

=======================

[![Build](https://github.com/MasWag/pandoc-satysfi-template/workflows/Build/badge.svg)](https://github.com/MasWag/pandoc-satysfi-template/actions/workflows/build.yml)

[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)

A pandoc custom writer and template for [SATySFi](https://github.com/gfngfn/SATySFi). You can convert any files supported by pandoc to SATySFi or PDF. You can generate the SATySFi and PDF versions of this README by `make` in the root directory.

Remark

======

This pandoc writer is *incomplete* i.e., it is unimplemented for some elements. Your contribution is **highly appreciated!!**

Requirements

============

* pandoc

* SATySFi

Options

=======

You can use the following options by giving `-V ` to pandoc

show-title

: If `-V show-title` is given, satysfi generates the title.

toc

: If `-V toc` is given, satysfi generates the TOC (table of contents).

Note

====

The template file `template.satysfi` is for a `.saty` file not for a `.satyh` file. If you want to convert to a `.satyh` file, you need to write a template by yourself. It is easy.

Example

=======

```bash

    pandoc -t ./satysfi.lua --template ./template.satysfi -s README.md -o README.saty -V show-title

```