Add support for font awesome 4

Closes gh-65

Author: philwebb

README.adoc

@@ -512,6 +512,25 @@ The package name is constructed by removing all `-` characters from the section
 
 
 
+=== Font Awesome Support
+Font Awesome support is available in the standard Asciidoctor HTML 5 backend, however, it is not available by default in this backend.
+This is to align with https://antora.org[Antora], which https://gitlab.com/antora/antora-ui-default/-/issues/58[doesn't currently support Font Awesome].
+
+If you want to enable Font Awesome 4 support in your documents you can set the `iconfont-fontawesome` attribute.
+This will allow you to use `+++icon:<name>[]+++` macros inside your markup, with images being resolved from the locally bundled `fontawesome.css` stylesheet.
+
+For example:
+
+[source,asciidoctor]
+----
+= Asciidoctor Font Awesome Document
+:iconfont-fontawesome:
+
+The folder icon is icon:folder[].
+----
+
+
+
 == Contributing
 If you're looking to contribute to this project, or you're just trying to navigate the code please take a look at the link:CONTRIBUTING.adoc[CONTRIBUTING] file.
 

gulpfile.js

@@ -45,6 +45,15 @@ function css() {
     .pipe(connect.reload());
 }
 
+function fontawesomeCss() {
+  return src("node_modules/fontawesome-4.7/css/font-awesome.css").pipe(dest(output + "/css"));
+}
+
+function fontawesomeFonts() {
+  return src("node_modules/fontawesome-4.7/fonts/*").pipe(dest(output + "/fonts"));
+}
+
+
 function img() {
   return src("src/main/img/*").pipe(dest(output + "/img"));
 }
@@ -101,7 +110,7 @@ function watchFiles(cb) {
   cb();
 }
 
-const build = series(info, css, img, jsSetup, jsSite);
+const build = series(info, css, fontawesomeCss, fontawesomeFonts, img, jsSetup, jsSite);
 
 exports.default = build;
 exports.build = build;

package-lock.json

@@ -37,5 +37,8 @@
     "dev": "gulp dev",
     "format": "prettier --write .",
     "checkFormat": "prettier --check ."
+  },
+  "dependencies": {
+    "fontawesome-4.7": "^4.7.0"
   }
 }

package.json

@@ -41,7 +41,7 @@ def initialize(backend, opts = {})
   def convert(node, transform = node.node_name, opts = nil)
     if transform == "document"
       configure_node_attrs node
-      return postprocess @htmlConverter.convert(node, transform, opts)
+      return postprocess(node, @htmlConverter.convert(node, transform, opts))
     end
     if transform == "listing"
       return convert_listing node
@@ -68,8 +68,12 @@ def configure_node_attrs(node)
     node.remove_attr "copycss"
   end
 
-  def postprocess(html)
-    html = html.gsub(/<link\ rel="stylesheet"(?!.*site\.css).*>\R?/, "")
+  def postprocess(node, html)
+    if node.attr? 'iconfont-fontawesome'
+      html = html.gsub(/<link\ rel="stylesheet"(?!.*(site|font-awesome)\.css).*>\R?/, "")
+    else
+      html = html.gsub(/<link\ rel="stylesheet"(?!.*site\.css).*>\R?/, "")
+    end
     match = html.match(/^(.*<body.*?>)(.*)(<\/body>.*)$/m)
     templateFile = File.join(File.dirname(File.expand_path(__FILE__)), "body_template.html")
     body = File.read(templateFile) % { :body => match[2] }

src/main/ruby/lib/spring-asciidoctor-backends/spring-html5-converter.rb

@@ -0,0 +1,15 @@
+[[standard]]
+= Asciidoctor Font Awesome Document
+Carrie Bradshaw; Jessica Fletcher; Diane Nguyen; Paul Sheldon; Jack Torrance
+:description: Asciidoctor using only standard markup
+:toc: left
+:toc-levels: 4
+:sectnums:
+:iconfont-fontawesome:
+
+This is an example asciidoctor file that uses font-awsome in the document.
+You need to set the `iconfont-complete` attribute for this to work.
+
+NOTE: You don't need font awesome for regular admon icons.
+
+The folder icon is icon:folder[].

src/test/asciidoc/fontawesome.adoc

@@ -0,0 +1,51 @@
+/*
+ * Copyright 2021 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package io.spring.asciidoctor.backend.integrationtest;
+
+import io.spring.asciidoctor.backend.testsupport.AsciidoctorExtension;
+import io.spring.asciidoctor.backend.testsupport.ConvertedHtml;
+import io.spring.asciidoctor.backend.testsupport.Source;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.ExtendWith;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+/**
+ * Integration tests for tab support.
+ *
+ * @author Phillip Webb
+ */
+@ExtendWith(AsciidoctorExtension.class)
+public class FontAwesomeIntegrationTests {
+
+	private static final String CSS_LINK = "<link rel=\"stylesheet\" href=\"css/font-awesome.css\">";
+
+	private static final String ICON_TEXT = "<i class=\"fa fa-folder\"></i>";
+
+	@Test
+	void fontAwesomeCssIsIncludedWhenAttributeIsSet(@Source("FontAwesome.adoc") ConvertedHtml html) {
+		assertThat(html.toString()).contains(CSS_LINK);
+		assertThat(html.toString()).contains(ICON_TEXT);
+	}
+
+	@Test
+	void fontAwesomeCssIsNotIncludedByDefault(@Source("NoFontAwesome.adoc") ConvertedHtml html) {
+		assertThat(html.toString()).doesNotContain(CSS_LINK);
+		assertThat(html.toString()).contains(ICON_TEXT);
+	}
+
+}

src/test/java/io/spring/asciidoctor/backend/integrationtest/FontAwesomeIntegrationTests.java

@@ -0,0 +1,4 @@
+= Font Awesome
+:iconfont-fontawesome:
+
+icon:folder[].

src/test/resources/io/spring/asciidoctor/backend/integrationtest/FontAwesome.adoc

@@ -0,0 +1,3 @@
+= Font Awesome
+
+icon:folder[].