Uses the Asciidoctor GhPages Action to automatically build the README.adoc to HTML, enabling GitHub Pages for the project.

.github/workflows/asciidoctor-ghpages.yml

@@ -0,0 +1,26 @@
+name: asciidoctor-ghpages
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but only for the master branch
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  # This workflow contains a single job called "build"
+  build:
+    # The type of runner that the job will run on
+    runs-on: ubuntu-latest
+
+    # Steps represent a sequence of tasks that will be executed as part of the job
+    steps:
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+
+    - name: asciidoctor-ghpages
+      uses: manoelcampos/[email protected]
+      with:
+        asciidoctor_params: --attribute=nofooter

README.adoc

@@ -3,7 +3,7 @@
 image:https://travis-ci.org/johncarl81/exportdoclet.svg?branch=master["Build Status", link="https://travis-ci.org/johncarl81/exportdoclet"] 
 
 A link:http://docs.oracle.com/javase/1.5.0/docs/guide/javadoc/doclet/overview.html[Doclet] that allows exporting javadoc
-comments containing link:http://asciidoctor.org[AsciiDoc] text to AsciiDoc files, enabling combining the javadocs into a broader AsciiDoc documentation for your Java project.
+comments containing link:http://asciidoctor.org[AsciiDoc] markup to AsciiDoc files, enabling combining the javadocs into a broader AsciiDoc documentation for your Java project.
 
 Instead of exporting the javadoc comments to standard HTML files, the ExportDoclet exports them to AsciiDoc files, that in turn can be converted to any output format supported by the link:http://asciidoctor.org[AsciiDoctor toolchain].
 
@@ -15,12 +15,12 @@ ExportDoclet encourages developers to write meaninguful and expanded documentati
 
 == Building the ExportDoclet
 
-ExportDoclet is a Java Maven project that can be built directly from any IDE or using the following maven command:
+ExportDoclet is a Java Maven project which can be built directly from any IDE or using the following maven command:
 
 [source,bash]
 mvn clean install
 
-That will build the tool and install it at your local maven repository, usually at the .m2 directory
+That will build the tool and install it at your local maven repository, usually at the `.m2` directory
 inside your home directory.
 
 == How to use ExportDoclet

pom.xml

@@ -61,7 +61,7 @@
         <dependency>
             <groupId>com.google.guava</groupId>
             <artifactId>guava</artifactId>
-            <version>17.0</version>
+            <version>26.0-jre</version>
         </dependency>
         <dependency>
             <groupId>junit</groupId>

src/main/java/org/asciidoctor/ExportDoclet.java

@@ -35,7 +35,7 @@ public class ExportDoclet extends Doclet {
      * Starts the doclet.
      * @param rootDoc the root of the program structure information.
      *                From this root all other program structure information can be extracted.
-     * @return true if the doclet was started successfuly, false otherwise
+     * @return true if the doclet was started successfully, false otherwise
      * @see Doclet#start(RootDoc)
      */
     @SuppressWarnings("UnusedDeclaration")
@@ -96,4 +96,4 @@ public static LanguageVersion languageVersion() {
     private boolean render(){
         return renderer.render();
     }
-}
+}