Skip to content

ojohnny/textlint-plugin-asciidoctor

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

37 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

textlint-plugin-asciidoctor

Asciidoctor support for textlint using asciidoctor.js.

Travis CI Build Status npm version

Installation

> npm install textlint-plugin-asciidoctor

Limitation

  • Currently, some syntax (e.g., comment, preamble) are not supported.
    • If you find unsupported syntax, please create an issue.
    • See test code for details.

Usage

{
  "plugins": [
    "asciidoctor"
  ]
}

File Extension

This plugin recognize these file extension as asciidoc file.

  • ".asciidoc",
  • ".adoc",
  • ".asc"

http://asciidoctor.org/docs/asciidoc-recommended-practices/

Tests

> npm test

Show TxtAST

> ./bin/asciidoc-to-textlint-ast.js < input.adoc | jq .
...

or

> npm install textlint-plugin-asciidoctor
> $(npm bin)/asciidoc-to-textlint-ast < input.adoc | jq .

Contributing

  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Alternatives

License

MIT

About

Yet another Asciidoctor support for textlint.

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%