From 02d8bbba1b9d6701d7127727c90b4eda6da0c6c5 Mon Sep 17 00:00:00 2001 From: Geoffrey Cline Date: Fri, 1 Nov 2024 18:53:11 -0500 Subject: [PATCH] add sample file --- latest/ug/book.adoc | 189 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 189 insertions(+) create mode 100644 latest/ug/book.adoc diff --git a/latest/ug/book.adoc b/latest/ug/book.adoc new file mode 100644 index 00000000..7bd92c17 --- /dev/null +++ b/latest/ug/book.adoc @@ -0,0 +1,189 @@ += Sample AsciiDoc Document +John Smith +v1.0, 2024-11-01 +:toc: +:icons: font +:source-highlighter: rouge +:experimental: + +== Introduction + +This is a sample AsciiDoc document demonstrating various formatting elements and features. + +[TIP] +==== +AsciiDoc is a powerful markup language that's great for technical documentation. +==== + +=== Purpose + +The purpose of this document is to showcase different AsciiDoc elements: + +* Text formatting +* Lists and tables +* Code blocks +* Admonitions +* And more! + +== Text Formatting + +Here are some examples of *bold text*, _italic text_, and `monospace text`. You can also do ^superscript^ and ~subscript~. + +You can also mark text as ##highlighted## or [.underline]#underlined#. + +=== Links and Cross References + +* https://asciidoctor.org[Visit the Asciidoctor website] +* <> +* link:filename.html[Link to a local file] + +== Lists + +.Ordered List +1. First item +2. Second item +.. Nested item a +.. Nested item b +3. Third item + +.Unordered List +* Apples +** Gala +** Honeycrisp +* Oranges +* Bananas + +.Checklist +* [x] Completed task +* [ ] Pending task +* [ ] Future task + +== Code Examples + +[source,python] +---- +def hello_world(): + print("Hello, AsciiDoc!") + return True +---- + +[source,javascript] +---- +function calculateSum(a, b) { + return a + b; +} +---- + +== Tables + +.Sample Table +|=== +|Header 1 |Header 2 |Header 3 + +|Cell 1.1 +|Cell 1.2 +|Cell 1.3 + +|Cell 2.1 +|Cell 2.2 +|Cell 2.3 +|=== + +[cols="1,1,2", options="header"] +.Columnar Table +|=== +|Name +|Role +|Description + +|John Smith +|Developer +|Writes code and documentation + +|Jane Doe +|Designer +|Creates user interfaces +|=== + +== Admonitions + +[NOTE] +==== +This is a note admonition block. +==== + +[WARNING] +==== +This is a warning admonition block. +==== + +[IMPORTANT] +==== +This is an important admonition block. +==== + +== Images + +.Sample Image Caption +image::https://example.com/image.png[Alt text,width=500] + +== Quotes + +[quote, Albert Einstein] +____ +Life is like riding a bicycle. To keep your balance you must keep moving. +____ + +[verse] +____ +Roses are red, +Violets are blue, +AsciiDoc is neat, +And so are you! +____ + +== Including Files + +// This would include another file +// include::path/to/file.adoc[] + +== Mathematical Equations + +LatexMath equation: + +[latexmath] +++++ +f(x) = x^2 + 2x + 1 +++++ + +== Custom Styles + +[.text-center] +This text is centered. + +[.big] +This text uses a custom 'big' style. + +== Footnotes and Glossary + +A term with a footnote.footnote:[This is the footnote text.] + +[glossary] +term:: Definition of the term +another term:: Definition of another term + +== Appendix + +[appendix] +== Additional Information + +This is appendix content. + +[bibliography] +== References + +* [[[ref1]]] Reference 1 +* [[[ref2]]] Reference 2 + +[index] +== Index \ No newline at end of file