Skip to content

How does it look if you use an .adoc file instead of a .md REAMDE file? - Now you know!

Notifications You must be signed in to change notification settings

mabkenar/adoc-as-a-readme

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 

Repository files navigation

AsciiDoc Article Title

Content entered directly below the header but before the first section heading is called the preamble.

First level heading

This is a paragraph with a bold word and an italicized word.

GitHub mascot
Figure 1. Image caption

This is another paragraph.[1]

Second level heading

Unordered list title
  • list item 1

    • nested list item

      • nested nested list item 1

      • nested nested list item 2

  • list item 2

This is a paragraph.

Example 1. Example block title

Content in an example block is subject to normal substitutions.

Sidebar title

Sidebars contain aside text and are subject to normal substitutions.

Third level heading

Listing block title
Content in a listing block is subject to verbatim substitutions.
Listing block content is commonly used to preserve code input.
Fourth level heading
Table 1. Table title
Column heading 1 Column heading 2

Column 1, row 1

Column 2, row 1

Column 1, row 2

Column 2, row 2

Fifth level heading

I am a block quote or a prose excerpt. I am subject to normal substitutions.

— firstname lastname
movie title
I am a verse block.
  Indents and endlines are preserved in verse blocks.
— firstname lastname
poem title and more

First level heading

Tip
There are five admonition labels: Tip, Note, Important, Caution and Warning.
  1. ordered list item

    1. nested ordered list item

  2. ordered list item

The text at the end of this sentence is cross referenced to the third level heading

First level heading

This is a link to the Asciidoctor User Manual. This is an attribute reference which links this text to the Asciidoctor Quick Reference Guide.


1. I am footnote text and will be rendered at the bottom of the article.

About

How does it look if you use an .adoc file instead of a .md REAMDE file? - Now you know!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published