Edit documentation content

Learn how to contribute documentation changes for the plugin.

Prerequisites

For small changes, writers can use the web browser and the web-based text editor of GitHub.

The preview of GitHub doesn’t take into account the Antora macros, therefore, consider using the IntelliJ AsciiDoc plugin for changes.

How-to edit content using only a web browser

Follow these steps to change the documentation content on the plugin’s homepage using the browser:

  1. Click on the “Edit this page” link on the documentation website of the plugin

  2. Edit the content

  3. Follow the instructions on the end of the page to commit the changes, creating a fork of the repository and submitting a pull request

Once a maintainer approves the pull request, the changes will be visible on the plugin’s homepage.

Optional: Writers can build the plugin’s documentation website locally for a preview by following the steps in Changing the documentation theme.

How-to edit content using an IDE on the local PC

Follow these steps to change the documentation content on the plugin’s homepage:

  1. Fork and clone the plugin’s repository: https://github.com/asciidoctor/asciidoctor-intellij-plugin

  2. Change documentation in the sub-folder doc

  3. Proofread changes in the editor’s live preview

  4. Update navigation contents in the nav.adoc file as needed to re-ordered, added or removed content

  5. Create a pull request on GitHub

Once a maintainer approves the pull request, the changes will be visible on the plugin’s homepage.

Optional: Writers can build the plugin’s documentation website locally for a preview by following the steps in Changing the documentation theme.