adoc/doc/a-tiny-subset-of-asciidoc-f...

81 lines
1.3 KiB
Plaintext
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

= Implemented markup elements
2022-12-20
== Headers
A header consists of the title of the post and various fields of metadata. It looks like this:
----
= An Example Document
Erik Winter <info@erikwinter.nl>
2020-12-01
:key1: value 1
:key2: value 2
----
=== Subtitle and Subsubtitle
----
== A Subtitle
== As SubSubTitle
----
=== List
----
* List item one
* List item two
* List item three
----
=== Code Block
----
----
func (d *Dummy) DoSomething() string {
return “No. I dont want to.”
}
func (d *Dummy) SudoDoSomething() string {
return “Ok. If you insist, Ill put my objections aside for a moment.”
}
----
----
=== Paragraph
A paragraph is a line of text that gets parsed to find inline elements.
== Inline Elements
Currently the following types are recognized:
* Strong and emphasis
* Link
* Inline code
=== Strong and Emphasis
----
a text with some *strong* words, that Id like to _emphasize_.
----
It is possible to combine the two for the same text.
=== Link
----
Check out this https://erikwinter.nl/[awesome website] now!
----
Whatever is between the opening bracket and the first space before that is taken as URL, so both absolute and relative links without domain are possible.
=== Inline Code
----
Some text with `code` in it.
----