https://github.com/origami-network/docker-pandoc

https://github.com/origami-network/docker-pandoc

command docker-image pandoc windows

Last synced: 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/origami-network/docker-pandoc
• Owner: origami-network
• License: other
• Created: 2018-09-01T09:54:58.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2018-10-19T20:49:42.000Z (over 7 years ago)
• Last Synced: 2025-10-19T08:55:59.807Z (8 months ago)
• Topics: command, docker-image, pandoc, windows
• Language: PowerShell
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
| master | latest |

| :--: | :--: |

| [![Build status](https://ci.appveyor.com/api/projects/status/cwr97n0st0rdxn9v/branch/master?svg=true)](https://ci.appveyor.com/project/BartDubois/docker-pandoc/branch/master) | [![Build status](https://ci.appveyor.com/api/projects/status/cwr97n0st0rdxn9v?svg=true)](https://ci.appveyor.com/project/BartDubois/docker-pandoc) |

Pandoc - Windows Docker image

==

[Pandoc](https://pandoc.org/) can convert between numerous markup and word processing formats.

It is a command-line tool, as such there is no graphic user interface.

Example bellow shows the input markdown and corresponding HTML output.

```markdown

Hello *pandoc*!

- one

- two

```

```html

Hello pandoc!



one

two



```


It is possible to convert back from HTML to markdown as well.

## Usage

This Docker image allows to use Pandoc without need of installation on Windows 2016 and Windows 10.

It accepts all parameters as specified by [Pandoc command line](https://pandoc.org/MANUAL.html#using-pandoc).

### Pull Docker image

Before start the image need to be pulled from the [Docker Hub](https://hub.docker.com/r/origaminetwork/pandoc/).

```console

> docker pull origaminetwork/pandoc:X.X.X.X.Y

```

Where `X.X.X.X.Y` is the version of the image.

### Generating HTML from markdown

For the file `input.markdown` located in `C:\Users\UserName\Documents\` folder, fallowing command will generate `output.html` document file.

```console

> docker run -v C:\Users\UserName\Documents:C:\Volume origaminetwork/pandoc:X.X.X.X.Y -f markdown -t html C:\Volume\input.markdown -o C:\Volume\output.html

```

See [specification](./Spec/Pandoc.Tests.ps1) for more examples.

## Contributing

In order to contribute to the project please fallow [Contributing Guidance](CONTRIBUTING.md).

## License

The project is licensed under [MIT License](LICENSE).