abcbhm/md2odt

Library for converting Markdown to OpenDocument (.odt)

MD2odt

MD2odt is a easy to use library for converting Markdown to OpenDocument (.odt).

• Web application: MD2odt-web (Online: https://md2odt.herokuapp.com/)
• Command line interface: MD2odt-cli

Features

• Input can be either plain Markdown file or ZIP file with one Markdown file and resources (images)
• Support for complete Markdown syntax
• Support for various Markdown extensions (turned off by default)
  • Autolinks
  • Emoji :octopus:
  • Strikethrough ~~something wrong~~
  • Subscript H~2~O
  • Superscript x^2^
  • Tables
  • Table of contents
• Syntax highlighting (all common languages)
• Support for both local and remote images (PNG, JPG, GIF, BMP, SVG)
• Support for templates – template is a regular ODF file with custom styles, front page, header, footer, etc.

Example

Maven

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Dependency:

<dependency>
    <groupId>com.github.abcBHM</groupId>
    <artifactId>MD2odt</artifactId>
    <version>master-SNAPSHOT</version>
</dependency>

Source code

import cz.zcu.kiv.md2odt.MD2odt;
import java.io.IOException;
import java.nio.charset.StandardCharsets;
import java.nio.file.Paths;

public class Example {

    public static void main(String... args) throws IOException {
        MD2odt.converter()
                .setInput(Paths.get("example.md"), StandardCharsets.UTF_8)
                .setTemplate(Paths.get("template.odt"))
                .setOutput(Paths.get("result.odt"))
                .enableAllExtensions()
                .convert();
    }
}

Example files

• Plain MD file
• ZIP with MD and resources
• Template

License

This project is licensed under the MIT License - see the LICENSE.txt file for details.

md2odt's Issues

[Highlighter] Better theme

Formatted text and images inside link

The "clickable" part of a link can contain formatted text as well as an image (see GitHub "badges").

• Filler
• ODT

problematic conversion SVG to PNG

occurs when working with batik library.. tried locally with same result

List Style

Set TextStyleNameAttribute to List using a StyleNames.LIST value.

Log adding images

It is a complicated and long running task that should be logged.

Suggestion

In two steps

• before: downloading image / adding local image...
• after: image added (or print error...)

listy

Implementovat víceúrovňový list.

Add support for SVG

table in example.md lost formatting after save

[ODT] Joined code blocks

Example input:

```java
first block
```

```java
second block
```

... looks like one code block.

[ODT] Paragraph - line breaks ignored

Remove the old Document implementation

[Highlighter] improve the way of retrieving color of CodeSectionType

As we talked. Could use a background color.

odt modifikace

Pokud by šlo programově rozbalit odt file, upravit a znovu zabalit do spustitelného.

Ideálně nějaký neprázdný dokument -> v contextu jen změnit dané slovo v dokumentu a uložit.
Při změně bacha ať obsahuje stejný počet znaků (mohlo by dělat problém v meta.xml).

Extension / tables

• Filler
• ODT

Extension / strikethrough

• Filler
• ODT

Collect remote assets

Fill Readme.md

• description
• features (+extensions)
• technologies?
• API use
• build, maven dep.

line breaks, creation of a new SpanContent

Create a new span content for line breaks.
see: #6 bug issue

Broken output

Example (from our README.md):

[![Build Status](https://travis-ci.org/abcBHM/MD2odt.svg?branch=master)](https://travis-ci.org/abcBHM/MD2odt)
[![codecov](https://codecov.io/gh/abcBHM/MD2odt/branch/master/graph/badge.svg)](https://codecov.io/gh/abcBHM/MD2odt)
[![](https://jitpack.io/v/abcBHM/MD2odt.svg)](https://jitpack.io/#abcBHM/MD2odt)

Nested formatting

A text may be italic and bold at once, etc.

• Filler (see 173b7a4)
• ODT (see dd81373)

Deploy to Maven Central Repository

After release...

[Highlighter] More languages

Something wrong with inline code

See example.md / HTML / Entities

Inside inline code: `© ¶ € ň`.

The first '&' is out of code span.

Extension / subscript

• Filler
• ODT

TextDocumentWrapper

Create a TextDocumentWrapper for odf document.

Extension / superscript

• Filler
• ODT

ZIP contains only working folder

check if a zip contains folder when .md is not found