asciidoctor-intellij-plugin | AsciiDoc plugin for products on the IntelliJ platform

by asciidoctor Java Version: 0.38.18 License: Apache-2.0

X-Ray Key Features Code Snippets Community Discussions(1)Vulnerabilities Install Support

kandi X-RAY | asciidoctor-intellij-plugin Summary

asciidoctor-intellij-plugin is a Java library typically used in Editor applications. asciidoctor-intellij-plugin has no bugs, it has no vulnerabilities, it has build file available, it has a Permissive License and it has low support. You can download it from GitHub.

A plugin for the IntelliJ platform (IntelliJ IDEA, RubyMine, etc.) that provides support for the AsciiDoc markup language. It also supports Antora, the documentation CMS build with AsciiDoc. To contribute as a developer, some issues are labeled with “good first issue”. Maintainers are willing to help. For more advanced topics, see tickets marked as “help wanted”. Feel free to choose these or any other ticket to participate, or create pull requests without a prior ticket.

Support

Quality

Security

License

Reuse

Support

asciidoctor-intellij-plugin has a low active ecosystem.

It has 322 star(s) with 135 fork(s). There are 15 watchers for this library.

There were 5 major release(s) in the last 12 months.

There are 108 open issues and 779 have been closed. On average issues are closed in 25 days. There are 5 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of asciidoctor-intellij-plugin is 0.38.18

Quality

asciidoctor-intellij-plugin has 0 bugs and 0 code smells.

Security

asciidoctor-intellij-plugin has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

asciidoctor-intellij-plugin code analysis shows 0 unresolved vulnerabilities.

There are 0 security hotspots that need review.

License

asciidoctor-intellij-plugin is licensed under the Apache-2.0 License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

asciidoctor-intellij-plugin releases are available to install and integrate.

Build file is available. You can build the component from source.

Installation instructions are available. Examples and code snippets are not available.

It has 36099 lines of code, 2340 functions and 519 files.

It has medium code complexity. Code complexity directly impacts maintainability of the code.

Top functions reviewed by kandi - BETA

kandi has reviewed asciidoctor-intellij-plugin and discovered the below as its top functions. This is intended to give you an instant insight into asciidoctor-intellij-plugin implemented functionality, and help decide if they suit your requirements.

Performs an action on the pdoc
Downloads Ascii document
Create a temporary folder to render images
Gets the pndoc file
Sets the html
Wrap the HTML in html
Prepares the given HTML and returns the image
Finds a temporary file in the images directory
Called when a character is removed
Save image
Generate AsciiDoc annotations
Executes the PsiElement
Binds another element to another element
Performs an action on the Asciido editor
List references to this element
Returns the placeholder text for the given AST node
Select the elements of a Psi element
Registers reference providers for the given element
Reads the content of the statement
Gets the references to this file
Returns an AsciiDocVisitor with the given parameters
Registers the browsers
Set html content
Send resource to preview
Process preprocessor
Create an Asciidoctor

Get all kandi verified functions for this library.

asciidoctor-intellij-plugin Key Features

No Key Features are available at this moment for asciidoctor-intellij-plugin.

asciidoctor-intellij-plugin Examples and Code Snippets

No Code Snippets are available at this moment for asciidoctor-intellij-plugin.

Community Discussions

Trending Discussions on asciidoctor-intellij-plugin

Enable rendering asciidoc operation in InteliJ Idea

QUESTION

Enable rendering asciidoc operation in InteliJ Idea

Asked 2019-Aug-05 at 12:54

Documenting rest api using spring-restdocs in InteliJ Idea is fine, but I missing rendered "include" snippets of operation macro.

...

ANSWER

Answered 2019-Aug-05 at 12:53

I've had a look at spring-restdocs-asciidoctor. The operation::[] is an extension that renders the content. It relies on an attribute snippets that needs to be set.

The IntelliJ plugin for AsciiDoc supports both ruby extensions and attributes for previews as experimental options.

To make it work I did the following:

checkout the project
running gradlew asciidoctor to generate the snippets
add a file .asciidoctorconfig to set the path to the generated snippets
add a directory .asciidoctor and place the extension in this directory
confirm the warning message "This project contains Asciidoctor Extensions..." in the IDE

You need to confirm the warning message every time you restart your IDE. As it will run Ruby code locally, this is a security issue. Maybe we'll enhance it in the future so you only need to reconfirm it once the extension's code changes.

The changes are on the following branch: https://github.com/ahus1/spring-restdocs/tree/poc_extension_intellij

Source https://stackoverflow.com/questions/57186505

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install asciidoctor-intellij-plugin

You can install the plugin (named “AsciiDoc”) from the plugins section inside your JetBrains IDE or download it from the JetBrains Plugin Repository. The most advanced and recommended preview modes (and default for new installations) are JavaFX and JCEF. Refer to the installation for a detailed overview of the features.

Support

Issues that can give you a good start are have the label “good first issue” and maintainers are willing to help. Feel free to choose these or any other ticket to contribute, or even create pull requests without a prior ticket. Please have a look at the “Contributor Guide”. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Asciidoctor Community Code of Conduct.

Find more information at: