/react-asciidoc

React Asciidoctor wrapper

Primary LanguageJavaScript

react-asciidoc

React wrapper around Asciidoctor.js

NPM registry NPM license

Demo

Here is an examples page

Install

# Yarn
yarn add react-asciidoc

# NPM
npm install --save react-asciidoc

Usage

import React from 'react';
import Asciidoc from 'react-asciidoc';
import 'react-asciidoc/style.css'; // base Asciidoc style

const DemoComponent = () => <Asciidoc>*Asciidoc* content here...</Asciidoc>;

Styling

You can use custom CSS. More info here...

API

Props

Property Type Required? Description
children String ✓ Asciidoc content as string
style Object Optional inline style to attach to outermost element.
className String Optional CSS className to attach to outermost element.
outerTagName string Tag name passed to document.createElement to create the outer container element. This is an advanced property; in most cases, the default ("div") should be used.

License

MIT © avin