Drafts

@cm3 の草稿置場 / 少々Wikiっぽく使っているので中身は適宜追記修正されます。

Markdown container format

This document is under construction. You can freely revise and disseminate this idea.

Introduction

The purpose of the Markdown container format is to simplify the exchange of markdown text files together with additional images between sandboxed applications. By using a single package file, applications do not need to acquire additional sandbox extensions to access files referenced by a plain text document. The structure of this format is very similar to EPUB Open Container Format and the purpose is very similar to TextBundle. To tell the truth, this introduction is based on the sentences of TextBundle.

Why don't you use TextBundle?

TextBundle Specification is too original.

This format is very similar to EPUB Open Container Format. META-INF directory is used in not only OCF but also JAR, APK or ODF.

Recommended Extention

.mdc

Typical structure

  • META-INF
    • container.xml
  • assets
    • fig1.jpg
  • index.md

container.xml

<?xml version="1.0"?>
<container version="1.0" xmlns="urn:oasis:names:tc:opendocument:xmlns:container">
    <rootfiles>
        <rootfile full-path="index.md" media-type="text/markdown" /> 
    </rootfiles>
</container>

ToDo

  • create library on github
  • write details

See Also