Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add sample file #808

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
189 changes: 189 additions & 0 deletions latest/ug/book.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,189 @@
= Sample AsciiDoc Document
John Smith <[email protected]>
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]
* <<purpose,Jump to Purpose section>>
* 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

Check warning on line 52 in latest/ug/book.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] latest/ug/book.adoc#L52

[RedHat.Spelling] Verify the word 'Honeycrisp'. It is not in the American English spelling dictionary used by Vale.
Raw output
{"message": "[RedHat.Spelling] Verify the word 'Honeycrisp'. It is not in the American English spelling dictionary used by Vale.", "location": {"path": "latest/ug/book.adoc", "range": {"start": {"line": 52, "column": 4}}}, "severity": "WARNING"}
* 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.

Check warning on line 134 in latest/ug/book.adoc

View workflow job for this annotation

GitHub Actions / vale

[vale] latest/ug/book.adoc#L134

[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.
Raw output
{"message": "[RedHat.TermsWarnings] Consider using 'such as' rather than 'like' unless updating existing content that uses the term.", "location": {"path": "latest/ug/book.adoc", "range": {"start": {"line": 134, "column": 9}}}, "severity": "WARNING"}
____

[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
Loading