ombrelin/pandoc-gui

Lightweight and cross-platform GUI wrapper for the pandoc command line

Pandoc GUI

This software aims to provide a clean and modern GUI to generate PDF documents from markdown using Pandoc, with the ability to pass several options, like :

• Custom code highlithing theme
• Headings numbers
• Font
• Link color
• Margin
• PDF Engine
• Table of contents

Pandoc GUI runs on .NET 6.

Screenshots

Prerequisites

Windows

Check that you have Pandoc and MikTex installed.

Using Chocolatey

choco install pandoc miktex -y

Using winget

winget install MiKTex
winget install Pandoc

Linux

sudo apt-get install pandoc texlive-latex-extra texlive-latex-recommended

MacOs

brew install pandoc
curl http://mirror.ctan.org/systems/mac/mactex/BasicTeX.pkg -o
sudo installer -pkg BasicTeX.pkg -target /

Install Release

Windows

• Download Installer from release
• Just run the installer

No need to install the .NET 6 Runtime, it has been bundled in the executable.

MacOS

WIP

Linux (Debian based)

• Download the deb package from release
• sudo dpkg -i <deb package> to install the deb package
• PandocGui to launch the app

No need to install the .NET 6 Runtime, it has been bundled in the executable.

Run Dev

Make sure you have the latest .NET 6 SDK installed.

git clone https://github.com/Ombrelin/pandoc-gui
cd pandoc-gui/src/PandocGui
dotnet run

On Mac / Linux : sudo dotnet run

Special Thanks

• AvaloniaUI
• ReactiveUI
• Pandoc
• @Naaviiss for help with macOS run & deployment
• @Grandkhan for the app icon

pandoc-gui's Issues

Add support for font size

Add a "copy pandoc command" button

Add toc depth option

set working directory to source file location for proper image handling

Add autocomplete search for font combobox

Would be great if we could write the font we would like instead of looking for it

Wrong message error

pandoc -f markdown "C:\Users\Red\Desktop\TP_SQL.md" -V geometry:a4paper --pdf-engine=xelatex --log="C:\Users\Red.pandoc-gui\logs\pandoc-logs-2021-10-12T18-36-44.json" -o "C:\Users\Red\Desktop\test.pdf"
app-logs-2021-10-12T18-29-49.log
pandoc-logs-2021-10-12T18-30-27.log
pandoc-logs-2021-10-12T18-32-43.log

Use Reactive Command execution for loading mechanism

work in progress for Linux version ?

It would be interesting to provide the port to Linux. Is this planned for soon ? Thank you for your response.

Create a reset button to clear the form

Does pandoc-gui support batch format conversion?

Fix crash when cancel file dialog

Inno Setup has fixed version

pandoc-gui/installer.iss

Line 3 in b1aa5e6

#define MyAppVersion "1.0.2"

Because this version is a fixed number and not based on the build, the version is always reported as 1.0.2 in control panel, which causes issues for winget

Found Pandoc GUI [Ombrelin.PandocGui] Version 1.1
This application is licensed to you by its owner.
Microsoft is not responsible for, nor does it grant any licenses to, third-party packages.
Downloading https://github.com/Ombrelin/pandoc-gui/releases/download/v1.1/pandoc-gui-setup.exe
  ██████████████████████████████  31.8 MB / 31.8 MB
Successfully verified installer hash
Starting package install...
Successfully installed

--> Refreshing environment variables

--> Comparing ARP Entries

DisplayName              DisplayVersion Publisher         ProductCode
-----------              -------------- ---------         -----------
Pandoc GUI version 1.0.2 1.0.2          Arsene Lapostolet {FCD2F146-6DB8-4DDC-AAA2-E9E5DA061AA6}_is1

Write Github Actions script to generate installable artifacts

• Windows :
  • Install chocolatey
  • Install innosetup with chocolatey
  • Write innosetup xml file
  • compile xml using innosetup cli
• Linux
• macOS

Load installed fonts and replace text input with combo box

Preset System supports Import / Export

User can export a preset to a file (use JSON) and import it back.

User JSON format.

Better error handling

Use pandoc log to file to have feedback and show detailed error message to the user using a popup.

"The system cannot find the file specified" error

If target pdf has different name from md file

Preset System

The user can save a set of options. Can browse can load a set of option.

Use EF Core with local SQLite database.

Provide a packaging for MacOS

Hello

Firstly, thanks for taking the time to make this! I am particularly knowledgeable about computers so this looks like it will be a great help in converting my word docs to markdown for Obsidian.

I am having trouble getting it to run on my Mac when I type the run command into the terminal it comes up with this

fatal: destination path 'pandoc-gui' already exists and is not an empty directory.
cd: no such file or directory: pandoc-gui/PandocGui
Couldn't find a project to run. Ensure a project exists in /Users/dockray, or pass the path to the project using --project. 

I already have installed the pandoc and Tex packages. Is there something I am missing or doing wrong?

Thanks for any help you can offer!!

Feature Ideas

Hi, this little utility is great! Here are some ideas I had for extra options in the GUI while I was using it:

1. Autofill 'Output file' with 'Input file' by default but with .pdf instead of .md obviously...
2. Portrait / Landscape geometry
3. Two / Three Columns
4. Link / URL Colour
5. Offset heading numbers: e.g. Heading 1 becomes a 'Title' and a Heading 2 is numbered X instead of X.X, this is achieved by --shift-heading-level-by=-1
6. Automatically select Custom PDF Engine if Custom Font is used. I've found lualatex is the most consistent to produce custom fonts.

Support selection of output format

can i convert markdown to epub using your windows gui ?
i have downloaded and installed your windows gui but there is no option to select epub format

please guide me little bit
thanks