Skip to content

Latest commit

 

History

History
298 lines (203 loc) · 5.03 KB

admonitions.adoc

File metadata and controls

298 lines (203 loc) · 5.03 KB

Admonitions

NOTE

Note

You’ve been down this road before.

$ npm i -g @antora/cli @antora/site-generator-default

  • list 1

  • list 2

Link example: Neo4j

Xref example: alpha.adoc

Cum dicat putant ne. Est in reque homero principes, meis deleniti mediocrem ad has. Altera atomorum his ex, has cu elitr melius propriae. Eos suscipit scaevola at.

TIP

Cum dicat putant ne. Est in reque homero principes, meis deleniti mediocrem ad has. Altera atomorum his ex, has cu elitr melius propriae.

Tip

This oughta do it!

Cum dicat putant ne. Est in reque homero principes, meis deleniti mediocrem ad has. Altera atomorum his ex, has cu elitr melius propriae. Eos suscipit scaevola at.

IMPORTANT

Important

Don’t forget this step!

$ npm i -g @antora/cli @antora/site-generator-default
  • list 1

  • list 2

Link example: Neo4j

Xref example: alpha.adoc

CAUTION

Caution

I wouldn’t try that if I were you.

$ npm i -g @antora/cli @antora/site-generator-default
  • list 1

  • list 2

Link example: Neo4j

Xref example: alpha.adoc

WARNING

Warning

Watch out!

$ npm i -g @antora/cli @antora/site-generator-default
  • list 1

  • list 2

Link example: Neo4j

Xref example: alpha.adoc

TIP

Tip
Key Points to Remember

If you installed the CLI and the default site generator globally, you can upgrade both of them with the same command.

$ npm i -g @antora/cli @antora/site-generator-default
  • list 1

  • list 2

Link example: Neo4j

Xref example: alpha.adoc

Admonition block margins

Note

Admonition block with a single paragraph of text.

Note

Admonition block with multiple paragraphs.

This is the second paragraph.

Note

Admonition block with multiple different elements.

  • List item 1

  • List item 2

Paragraph of text.

Note

Admonition block with multiple different elements.

  • List item 1

  • List item 2

$ npm i -g @antora/cli @antora/site-generator-default
Note
Admonition with title text

Admonition block with multiple different elements.

  • List item 1

  • List item 2

$ npm i -g @antora/cli @antora/site-generator-default
Warning
$ npm i -g @antora/cli @antora/site-generator-default
$ npm i -g @antora/cli @antora/site-generator-default
Warning
Admonition with title text
$ npm i -g @antora/cli @antora/site-generator-default

Nominavi luptatum eos, an vim hinc philosophia intellegebat. Eu mea inani iriure.

Admonition in a table

Parameter Explanation

Parameter name

Parameter explanation Lorem ipsum

Dolor sit est.

Note

Note text goes here. Note should be nicely aligned and have no borders

Admonition first element in an example block

Warning

Admonition should be given enough margin if it is the first element in an example block.

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.

Tip

Admonition should be given normal margin if it is not the first element in an example block.

Icons in tables

Icons that are not part of an admonition block should have no color filter applied.

Type Date support Time support Time zone support

DATE

[check]

LOCAL TIME

[check]

ZONED TIME

[check]

[check]

LOCAL DATETIME

[check]

[check]

ZONED DATETIME

[check]

[check]

[check]

DURATION

-

-

-

Admonition that contains a code block

docker container exec -u neo4j -it <containerName> /bin/bash
Tip

If working with a Neo4j Docker container, ensure you connect to it with the user neo4j before issuing import commands, or you will get permission issues after the import.

docker container exec -u neo4j -it <containerName> /bin/bash

Admonition that contains a table?

Tip

This is an admonition that contains a table.

Type Date support Time support Time zone support

DATE

[check]

LOCAL TIME

[check]

ZONED TIME

[check]

[check]

LOCAL DATETIME

[check]

[check]

ZONED DATETIME

[check]

[check]

[check]

DURATION

-

-

-

Admonition with a title

Note
note with title

This is a note with a title.