Example AsciiDoc content

doc/org.eclipse.cdt.doc.user/.asciidoctorconfig.adoc

@@ -0,0 +1,2 @@
+// support image rendering within the Asciidoctor Editor
+:imagesdir: {asciidoctorconfigdir}/images

doc/org.eclipse.cdt.doc.user/.gitignore

@@ -1 +1,2 @@
+/html/
 /workspace/

doc/org.eclipse.cdt.doc.user/build.properties

@@ -38,7 +38,8 @@ bin.includes = about.html,\
                intro/,\
                notices.html,\
                book.css,\
-               index*/
+               index*/,\
+               html/
 
 bin.excludes = build.properties,\
 			   customBuildCallbacks.xml

doc/org.eclipse.cdt.doc.user/pom.xml

@@ -40,6 +40,32 @@
 					</execution>
 				</executions>
 			</plugin>
+			<plugin>
+				<groupId>org.asciidoctor</groupId>
+				<artifactId>asciidoctor-maven-plugin</artifactId>
+				<version>3.0.0</version>
+				<executions>
+					<execution>
+						<id>adoc-to-html</id>
+						<phase>generate-resources</phase>
+						<goals>
+							<goal>process-asciidoc</goal>
+						</goals>
+						<configuration>
+							<outputDirectory>${project.basedir}/html</outputDirectory>
+							<attributes>
+								<icons>font</icons>
+								<imagesdir>../images</imagesdir>
+								<linkcss />
+								<source-highlighter>coderay</source-highlighter>
+								<stylesdir>..</stylesdir>
+								<stylesheet>help.css</stylesheet>
+								<toc>macro</toc>
+							</attributes>
+						</configuration>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 

doc/org.eclipse.cdt.doc.user/src/asciidoc/example.adoc

@@ -0,0 +1,41 @@
+////
+Copyright (c) 2024 John Dallaway and others
+This program and the accompanying materials
+are made available under the terms of the Eclipse Public License 2.0
+which accompanies this distribution, and is available at
+https://www.eclipse.org/legal/epl-2.0/
+
+SPDX-License-Identifier: EPL-2.0
+
+Contributors:
+    John Dallaway - initial content
+////
+
+// support image rendering and table of contents within GitHub
+ifdef::env-github[]
+:imagesdir: https://raw.githubusercontent.com/eclipse-cdt/cdt/main/doc/org.eclipse.cdt.doc.user/images
+:toc:
+:toc-placement!:
+endif::[]
+
+= Example document
+
+toc::[]
+
+== Images
+
+Example image:
+
+image:search.png[Search dialog]
+
+== Tables
+
+Example table:
+
+[options="header"]
+|===
+|Column A |Column B
+|Cell 1A  |Cell 1B
+|Cell 2A  |Cell 2B
+|Cell 3A  |Cell 3B
+|===