https://github.com/jtanguy/gatsby-transformer-asciidoctor

Gatsby transformer plugin for Asciidoc using asciidoctor.js
https://github.com/jtanguy/gatsby-transformer-asciidoctor

Last synced: 23 days ago
JSON representation

Gatsby transformer plugin for Asciidoc using asciidoctor.js

• Host: GitHub
• URL: https://github.com/jtanguy/gatsby-transformer-asciidoctor
• Owner: jtanguy
• License: mit
• Created: 2019-01-07T20:38:40.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-07T22:32:16.000Z (almost 6 years ago)
• Last Synced: 2024-04-24T22:01:56.180Z (8 months ago)
• Language: JavaScript
• Size: 31.3 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.adoc
  • License: LICENSE

Awesome Lists containing this project

README

        
= gatsby-transformer-asciidoctor

Julien Tanguy

v0.1.0, 2019-01-07: Initial version 

Parses asciidoc files using link:https://github.com/asciidoctor/asciidoctor.js[asciidoctor.js]

== Install

`npm install --save @jtanguy/gatsby-transformer-asciidoctor`

== How to use

[source,javascript]

----

// In your gatsby-config.js

plugins: [

  {

    resolve: `@jtanguy/gatsby-transformer-asciidoctor`,

  },

],

----

== Parsing algorithm

It recognizes only files with the `adoc` extensions as asciidoc.

Each asciidoc file is parsed into a node of type `Asciidoctor`.

The following standard attributes are stored in the document's frontmatter:

* `title`

* `date`

* `version`

* `remark`

* `author`

* `authors`: a list of authors, with the following fields:

** `name`

** `firstname`

** `lastname`

** `email`

** `initials`

The following non-standard attributes are stored in the document's frontmatter

`description`:: The `description` attribute

`tags`:: The `tags` attribute. The value is split into a list using `;` as a delimiter