Code Monkey home page Code Monkey logo

asciidoctor-xml-ast's Introduction

asciidoctor-ast-xml

This repository implements an Asciidoctor converter to generate a XML file with the syntax nodes of a parsed document.

Usage

The converter is available as a Ruby gem, and can be installed with the following command:

$ gem install asciidoctor-xml-ast

The gem includes the executable asciidoctor-xml-ast, which you can use instead of asciidoctor:

$ asciidoctor-xml-ast document.adoc

Alternatively, you can invoke asciidoctor directly, and add the options --require asciidoctor-ast-xml and --backend xml-ast:

$ asciidoctor -r asciidoctor-xml-ast -b xml-ast document.adoc

In the previous examples, the output will be in the document.ast.xml file.

Example

The following document:

= Lorem Ipsum

== Dolor Sit Amet

Cillum dolore eu *fugiat* nulla pariatur

Generates a XML like this:

<document title="Lorem Ipsum" ... >
  <section id="_dolor_sit_amet" title="Dolor Sit Amet">
    <paragraph>Cillum dolore eu <inline-quoted type="strong">fugiat</inline-quoted> nulla pariatur</paragraph>
  </section>
</document>

The <document> element contains a lot of attributes, which have been removed in this example so it is easier to read.

The actual output is not indented. The previous example is formatted with xmllint.

asciidoctor-xml-ast's People

Contributors

ayosec avatar

Stargazers

 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.