https://github.com/ggrossetie/asciidoctor-tei

An Asciidoctor converter for TEI
https://github.com/ggrossetie/asciidoctor-tei

asciidoctor openedition tei xml

Last synced: 4 months ago
JSON representation

An Asciidoctor converter for TEI

• Host: GitHub
• URL: https://github.com/ggrossetie/asciidoctor-tei
• Owner: ggrossetie
• License: mit
• Created: 2019-11-27T13:46:00.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T06:51:04.000Z (almost 2 years ago)
• Last Synced: 2024-05-21T12:26:03.531Z (9 months ago)
• Topics: asciidoctor, openedition, tei, xml
• Language: JavaScript
• Size: 419 KB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# `asciidoctor-tei`

> Convert [AsciiDoc documents][asciidoc] into XML/TEI files,

> at least a subset used by [OpenEdition publishing][openedition],

> as documented by the [XML/TEI OpenEdition Schema][schema-repo].

`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

```bash

$ asciidoctor-tei ./docs/sample.adoc

```

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

```bash

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

```

### JavaScript API

```js

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 

[preamble]

...

= Chapter 1

...`)

```

## Install

```bash

$ npm install asciidoctor asciidoctor-tei

```

[asciidoc]: https://asciidoctor.org/

[openedition]: https://www.openedition.org/

[asciidoctor.js]: https://npmjs.com/asciidoctor

[Node.js]: https://nodejs.org/

[schema-repo]: https://github.com/OpenEdition/tei.openedition