Skip to content

ggrossetie/asciidoctor-tei

Repository files navigation

asciidoctor-tei

Convert AsciiDoc documents into XML/TEI files, at least a subset used by OpenEdition publishing, as documented by the XML/TEI OpenEdition Schema.

asciidoctor-tei is a companion module for asciidoctor.js in order to be used with Node.js or within a Web browser.

Note: the module is in active development, things might look incomplete or broken.

Usage

Command line

$ asciidoctor-tei ./docs/sample.adoc

Note: you can also use asciidoctor command line to run the Asciidoctor TEI converter:

$ asciidoctor --require asciidoctor-tei -b tei ./docs/sample.adoc

JavaScript API

const asciidoctor = require('@asciidoctor/core')()
const teiConverter = require('asciidoctor-tei')
teiConverter(asciidoctor)

const xmlString = asciidoctor.convert(
`= My Academic Paper: From text to text
John Doe <john.doe@example.com>

[preamble]
...

= Chapter 1
...`)

Install

$ npm install asciidoctor asciidoctor-tei