AsciiDoc snippets for GitHub

AsciiDoc.adoc

Collection of things you can do with AsciiDoc in GitHub

This is WIP to see what works and what not.

Admonitions (work)

ℹ️	A sample note admonition. We can use gemoji icons in the Asciidoctor markup. We assign an icon name to the document attributes tip-caption, note-caption and important-caption.

💡

It works!

❗	Asciidoctor is awesome, don’t forget!

🔥	Don’t forget to add the …​-caption document attributes in the header of the document on GitHub.

⚠️	You have no reason not to use Asciidoctor.

Source linenums (doesn’t work)

It looks like those are not supported in the GitHub. Nor the global ones, nor block level.

// File: main.go
func main() {
  fmt.Println("Hello AsciiDoc")
}

Collapsible content (work)

Read more…​

• Hello AsciiDoc

Inline code syntax (doesn’t work, need more research)

There goes some func main(){} code snippet.

Emails (work)

Dzintars Klavins <dzintars.dev@gmail.com>

Attributes (work)

My first name is Dzintars

Include external code snippet (doesn’t work)

link:https://raw.githubusercontent.com/oswee/terraform-libvirt-domain/master/main.tf[role=include]

https://github.com/oswee/terraform-libvirt-domain/blob/76eae28baff5a32781415598ea37c0fb2f0e5363/main.tf#L10-L15

References

• https://gist.github.com/dcode/0cfbf2699a1fe9b46ff04c41721dda74

• asciidoctor/asciidoctor#1981

• github/markup#1095 (comment)