Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/synyx/pandoc-web

Simple web interface to use convert markdown to textile via pandoc
https://github.com/synyx/pandoc-web

Last synced: about 1 month ago
JSON representation

Simple web interface to use convert markdown to textile via pandoc

Awesome Lists containing this project

README

        

# Pandoc Web

This project aims to create a web interface for the pandoc command line tool to make it more accessible and easier to use.

## Dev

First install all dependencies:

```shell
npm install
```

then run the application in dev mode:

```shell
npm run dev
```

You will be able to access the dev application on port `8081`.

## Building

Run:

```shell
npm run build
```

You will be able to start your application in the project root the following way:

```shell
node ./backend/dist/main.js
```

The application will now be running on port `8080` and serve the frontend as well as the API.

Running the application expects pandoc to be installed on your machine and be accessible with the configured `PATH` env variable.

## Docker

You can run this via Docker using the published package:

```shell
docker run --rm -p 8080:8080 ghcr.io/synyx/pandocweb:latest
```

You can now open the web interface locally on http://localhost:8080.

## License

This project is licensed under the MIT license.
The panda icon is by OpenMoji – the open-source emoji and icon project. License: CC BY-SA 4.0