Skip to content

Latest commit

 

History

History
226 lines (173 loc) · 5.72 KB

asciidoc.md

File metadata and controls

226 lines (173 loc) · 5.72 KB

AsciiDoc Tools

Links

asciidoctor.org

Others

Sections

  • = Document Title (Level 0)
  • == Level 1 Section Title
  • === Level 2 Section Title
  • ==== Level 3 Section Title
  • ===== Level 4 Section Title
  • ====== Level 5 Section Title

ℹ️ Add [#primitives-nulls] before for explicit id

ℹ️ Use <<section title>> to link to a specific section

ℹ️ Use [[some_label]] to define a section <<some_label>> to link to that section

Formatting

  • *bold*

  • _italics_ : _camelCase_ ou __snake_case__

  • ^supertext^ (without space)

  • ~subtext~ (without space)

  • #overline text#

  • [color]#overline red text#

  • Lien : https://asciidocfx.com/[AsciidocFX]

  • HR : A line of three or more apostrophe characters will generate a ruler line. It generates a ruler (hr) tag for HTML : '''

  • Horizontal rule : '''

  • Page break : <<<

Images

🔗 https://asciidoctor.org/docs/user-manual/#images

syntaxe : image::path[alt="Flower",title="Flower",width=640,height=480,float="right",align="center",pdfwidth="100%"]

image:icons/play.png[Play, title="Play"]

Lists

ℹ️ To force the start of a new list, offset the two lists by an empty line comment.

Inclusions

include::inc/sub_file.adoc[]

Blocks

Notes, Tips, ...

NOTE, TIP, IMPORTANT, WARNING, CAUTION

NOTE: Text
[NOTE]
.Title
--
Text
--
[TIP]
.Title
--
Text
--

Captions

[caption="Example 1: "]
.An example with a custom caption
=====================================================================
Qui in magna commodo, est labitur dolorum an. Est ne magna primis
adolescens.
=====================================================================

Quotes

[quote, Ben Parker, Spiderman Movie]
____
With great power comes great responsibility.
____
[quote,'http://en.wikipedia.org/wiki/Samuel_Johnson[Samuel Johnson]']
_____________________________________________________________________
Sir, a woman's preaching is like a dog's walking on his hind legs. It
is not done well; but you are surprised to find it done at all.
_____________________________________________________________________

Q&A

[qanda]
What is Asciidoctor?::
  An implementation of the AsciiDoc processor in Ruby.
What is the answer to the Ultimate Question?:: 42

TOC

🔗 https://asciidoctor.org/docs/user-manual/#user-toc

  • :toc: auto|left|right|macro|preamble Defaults to auto if value is unspecified. When toc is set to preamble, the TOC is placed immediately below the preamble.
  • :toc-title: Contents Default value is Table of Contents.
  • :toclevels: 4 Default value is 2.
  • :!toc-title:

Tables

[cols="^1,12",options="header"]
|===
|Repère|Commentaire
a|icon:thumbs-up[2x green]
a|TODO
|===
  • cols="10%,20%,70%" 3 colonnes de respectivement 10, 20 et 70% de large
  • cols="1,12" Colonne 2 12 fois plus grande que colonne 1
  • ^1 1ère colonne alignée au centre
  • a|xxx indique que le format de la colonne est Asciidoc, sinon il n'interprête pas l'intérieur comme du asciidoc
  • ^.^ colonne alignée au centre et au milieu

Colors

ℹ️ https://en.wikipedia.org/wiki/Web_colors#HTML_color_names

Exemples :

  • [navy]*Maintenabilité*
  • icon:thumbs-down[2x red]

Symbols

Special-characters

Inline Icons

  • icon:bolt[] (foudre)
  • icon:heart[]
  • icon:tags[]
  • icon:shield[]
  • icon:comment[]
  • icon:file[]
  • icon:battery-full[]
  • icon:cog[] icon:cogs[] (roue(s) crantée)
  • icon:thumbs-up[]
  • icon:thumbs-down[]
  • icon:exclamation-circle[]
  • icon:warning[]
  • icon:info[]
  • icon:bell[]
  • icon:check[]
  • icon:check-circle[]
  • icon:check-square[]
  • icon:bullhorn[] (megaphone)
  • icon:bug[]
  • icon:ban[]
  • icon:eye[]
  • icon:leaf[] (spring)
  • icon:tint[] (goutte)
  • icon:linux[]
  • icon:github-square[]
  • icon:toggle-on[] icon:toggle-off[]

ℹ️ https://fontawesome.com/icons

GitHub configuration

ifndef::env-github[:icons: font]
ifdef::env-github[]
:!toc-title:
:caution-caption: :fire:
:important-caption: :exclamation:
:note-caption: :paperclip:
:tip-caption: :bulb:
:warning-caption: :warning:
endif::[]