Asciidoc语法

如下所示为Asciidoc自带的cheatsheet中的内容以及预览。

:imagesdir: images= Asciidoc Cheatsheet<<<Asciidoc is a rich text based markup language. A document written with Asciidoc can easily be converted to *HTML*, *_PDF_*, *Docbook*, *_Mobi_*, *Epub*, and *Odt* formats. This cheatsheet shows you the common features of Asciidoc Markup language.'''== [underline]#Basic formats#*Bold* , _İtalic_ , [underline]#Underscore# , To^p^ , Dow~n~'''== [underline]#Title levels#There are 6 Level titles as HTML. First one is for document title.[source,adoc]
----
= Level 1Content ...== Level 2Content ...=== Level 3Content ...==== Level 4Content ...===== Level 5Content ...
----'''== [underline]#Lists#There are ordered, unordered, checked and labeled list elements..Unordered list
* deep 1
** deep 2
*** deep 3
**** deep 4
***** deep 5
* deep 1.Ordered list
. Order 1
. Order 2
.. Order 2a
.. Order 2b
. Order 3.Checked list
- [*] checked
- [x] checked
- [ ] unchecked
-     normal.Labeled list
Elma:: Eski Türkçe'de "alma" diye bilinen adının, meyvenin rengi olan "al" (kırmızı)'dan geldiği bilinmektedirArmut:: Gülgiller (Rosaceae) familyasının Maloideae alt familyasında sınıflanan Pyrus cinsine ait ağaç nitelikli bitki türleriyle, bu türlerden bazılarının yenilebilir meyvelerinin ortak adı.'''== [underline]#Links#You can use links:http://asciidocfx.org - AsciidocFXhttp://asciidocfx.org[AsciidocFX]'''== [underline]#Images#You can declare images with `image::` prefix and `[]` suffix. Path may be _relative_ or _absolute_ .=== Basitimage::http://kodcu.com/wp/wp-content/uploads/2014/11/logo-kodcu-com5.png[]=== Detaylıimage::http://kodcu.com/wp/wp-content/uploads/2014/11/logo-kodcu-com5.png[caption="Şekil 1. ",title="Kodcu.com",alt="Kodcu.com"]'''== [underline]#Code higlighting#You can declare inline or block based codes with Asciidoc syntax..Inline
Reference code like `types` or `methods` inline..Code block
[source,java]
----
public interface Hello {void hello();}
----You can use numbered elements named `callouts` in Asciidoc..Numbered code block
[source,ruby]
----
require 'sinatra' // <1>get '/hi' do // <2>"Hello World!" // <3>
end
----
<1> Library import
<2> URL mapping
<3> Content for response'''== [underline]#Blocks#Sınırlandırılmış bloklar 4'er özel karakter ile sınırlandırılmış alanlardır.=== _Sidebar_ block.Başlık (opsiyonel)
****
Bu blok türünün adı *Sidebar* bloktur.
****=== Example block.Başlık (opsiyonel)
====
Bu blok türünün adı *Example* bloktur.
====ifdef::backend-html5[]
=== Passthrough block++++
Bu blok türünün adı <b>Passthrough</b> bloktur. Bu blok içerinde HTML elemanları kullanabilirsiniz.
<br/>
<br/>
<u>Örneğin;</u>
<br/><br/>
<ul><li>Ali</li><li>Veli</li><li>Selami</li>
</ul>
++++
endif::[]=== BlockquoteS block.Başlık (opsiyonel)
[quote, Hakan Özler, AspectJ Ebook]
____
AspectJ dilinin kullandığı yapılar 3 kısımda toplanmıştır.Bunlar:: Ortak, Dinamik ve Statik crosscutting (enine kesen) bölümlerdir.Bu bölümler, içlerinde farklı bileşenleri toplayarak bizim mevcut *OOP* sistemimizi *AOP* mantığı ile harmanlamamıza imkan veriyorlar.
____'''== [underline]#Uyarı blokları#Asciidoc işaretleme dilinde 5 tip uyarı (admonition) bloğu bulunmaktadır. Bu blokların kendine has ikonları bulunmaktadır..Not bloğu
[NOTE]
====
Burası bir not bloğu
====.Önemli bloğu
[IMPORTANT]
====
Burası bir önemli bloğu
====.İpucu bloğu
[TIP]
====
Burası bir ipucu bloğu
====.Dikkat bloğu
[CAUTION]
====
Burası bir dikkat bloğu
====.Uyarı bloğu
[WARNING]
====
Burası bir uyarı bloğu
====.Icon bloğuAsciidocFX ile http://fortawesome.github.io/Font-Awesome/icons/[FontAwesome] ikonlarını kullanabilirsiniz.icon:tags[] ruby, asciidoctor +
icon:folder[] ruby, asciidoctor +
icon:file[] ruby, asciidoctor +
icon:facebook[] ruby, asciidoctor +
icon:github[] ruby, asciidoctor +
icon:twitter[] ruby, asciidoctor'''
== [underline]#Tablolar#Asciidoc ile hemen hemen tüm kompleks tablo yapılarını kurabilirsiniz.=== Basit bir tablo.Başlık (opsiyonel)
[options="header,footer"]
|=======================
|Col 1|Col 2      |Col 3
|1    |Item 1     |a
|2    |Item 2     |b
|3    |Item 3     |c
|6    |Three items|d
|========================== Kompleks bir tablo.Başlık (opsiyonel)
|====
|Date |Duration |Avg HR |Notes
|22-Aug-08 .2+^.^|10:24 | 157 |
Worked out MSHR (max sustainable
heart rate) by going hard
for this interval.
|22-Aug-08 | 152 |
Back-to-back with previous interval.
|24-Aug-08 3+^|none
|====== [underline]#AsciidocFX eklentileri#AsciidocFX metin editörü, *UML* diagramları, *matematiksel kompleks formüller* ve *JavaFX Chart* için üç özel eklentiye sahiptir.=== JavaFX Charts ExtensionJavaFX has 8 kind of Chart component and AsciidocFX supports all of them.==== Pie Chart[chart,pie,file="secim-2014-pie.png",opt="title=2014 YEREL SEÇİM SONUÇLARI"]
--
AKP,  45.6, orange
CHP,  27.8,red
MHP,  15.2
BDP,  4.2
SP,  2
--==== Area Chart[chart,area,file="area-chart.png"]
--
//April
1,  4
3,  10
6,  15
9,  8
12, 5//May
1,  20
3,  15
6,  13
9,  12
12, 14
--For other charts and available options, look at https://github.com/asciidocfx/AsciidocFX/wiki/Chart-Extension[Chart extension] wiki page!=== PlantUML ExtensionPlantUML metinsel olarak yazılan ifadelerle zengin UML diagramları oluşturmaya olanak tanıyan, Java bazlı bir teknolojidir. AsciidocFX gömülü olarak PlantUML desteklemektedir..Başlık (opsiyonel)
[uml,file="uml-diagram.png"]
--
abstract class AbstractList
abstract AbstractCollection
interface List
interface CollectionList <|-- AbstractList
Collection <|-- AbstractCollectionCollection <|- List
AbstractCollection <|- AbstractList
AbstractList <|-- ArrayListclass ArrayList {Object[] elementDatasize()
}enum TimeUnit {DAYSHOURSMINUTES
}annotation SuppressWarnings
--.UML http://plantuml.sourceforge.net/ditaa.html
[uml,file="ditaa-diagram.png"]
--
@startditaa
+--------+   +-------+    +-------+
|        +---+ ditaa +--> |       |
|  Text  |   +-------+    |diagram|
|Document|   |!magic!|    |       |
|     {d}|   |       |    |       |
+---+----+   +-------+    +-------+:                         ^|       Lots of work      |+-------------------------+
@endditaa
--.UML http://plantuml.sourceforge.net/ditaa.html
[uml,file="dot-diagram.png"]
--
@startdot
digraph foo {node [style=rounded]node1 [shape=box]node2 [fillcolor=yellow, style="rounded,filled", shape=diamond]node3 [shape=record, label="{ a | b | c }"]node1 -> node2 -> node3
}
@enddot
--=== MathJAX ExtensionMathJAX matematiksel kompleks formüllerin, metinsel olarak ifade edildiği çeşitli dilleri (MathML, Tex, AsciiMath) görsel olarak çıktılayan bir teknolojidir. AsciidocFX gömülü olarak MathJAX desteklemektedir. AsciidocFX ile MathML ve Tex biçimlerinde kompleks formülleri PNG resmi olarak eşzamanlı olarak dökümanlarınızda kullanabilirsiniz.==== Tex ile formül örneği.Başlık (opsiyonel)
[math,file="tex-formula.png"]
--
\begin{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xyp
\end{align}
--==== MathML ile formül örneği.Başlık (opsiyonel)
[math,file="mathml-formula.png"]
--
<math xmlns="http://www.w3.org/1998/Math/MathML" display="block"><mi>x</mi><mo>=</mo><mrow><mfrac><mrow><mo>−</mo><mi>b</mi><mo>±</mo><msqrt><msup><mi>b</mi><mn>2</mn></msup><mo>−</mo><mn>4</mn><mi>a</mi><mi>c</mi></msqrt></mrow><mrow><mn>2</mn><mi>a</mi></mrow></mfrac></mrow><mtext>.</mtext>
</math>
--=== Filesystem Tree Viewers2 farklı yolla dosya sisteminin ağaç yapısını "tree" opsiyonu ile oluşturabilirsiniz.==== Birinci Yol.Filesystem Tree
[tree,file="filesystem-tree-viewer.png",height="+30",width="+100"]
--
#booksample
##asciidoctor.css
##book.asc
##chapter-01.asc
##chapter-02.asc
##chapter-03.asc
##chapter-04.asc
##chapter-05.asc
##chapter-06.asc
##images
###kodcu.png
###mathml-formula.png
###tex-formula.png
###uml-diagram.png
--

预览：

Asciidoc语法相关推荐

Asciidoc语法大全
Asciidoc是一种基于富文本的标记语言. 使用Asciidoc编写的文档可以轻松转换为* HTML , PDF , Docbook , Mobi , Epub 和 Odt *格式. 基本格式 *加 ...
Asciidoctor基础语法
简介 Asciidoctor是一个快速文本处理器和发布工具链,用于将文本内容转为HTML,PDF,PPT或者其他格式默认提供了一系列样式,用于表现HTML内容. Asciidoctor可以运行在Ru ...
[AsciiDoc]_[项目管理]_[适合写书写需求文档的纯文本轻量级标记语言]
场景 markdown适合写短篇文章,但是不适合写书,需求文档这类复杂多页的文档.有什么文本格式适合写需求文档呢?并且能生成PDF或者docx格式方便阅读? 说明在阅读gradle的userguid ...
[Swagger] Asciidoc 配置静态章节
目录 Asciidoc 配置静态章节 MAVEN 静态章节配置 MAVAN命令切换输出方式 Asciidoc InteillJ IDEA Plugin REFRENCES 更多 Asciidoc 配置 ...
asciidoc_使用AsciiDoc编写文档
asciidoc 我在一个月的午餐中编写" 学习Linux"时发现了AsciiDoc . AsciiDoc是一种用于编写书籍的非常详尽的标记语言-想想Markdown ,但是具有更 ...
AsciiDoc入门
AsciiDoc英文官网:asciidoc.org 英文官网:https://asciidoctor.org/ 中文官网:https://asciidoctor.cn/ AsciiDoc语法文档(中文 ...
Github 是如何用 Github 撰写 Github 文档的
原文:https://github.com/blog/1939-... 译者:@公子一份好的文档能够帮助人们理解,使用以及贡献代码到你的项目中,但这只是一个生成文档的方程式的一半.生成文档的底层系统 ...
使用 Gitbook 打造你的电子书
本文详细讲解了 Gitbook 生成电子书的完整过程,内容包括:安装.命令.配置.文档结构.生成电子书.部署. 限于篇幅,本文不介绍任何 Gitbook 定制化页面的内容. 想看看 Gitbook 在 ...
gitbook 安装使用
概述 GitBook 是使用 GitHub / Git 和 Markdown(或AsciiDoc)构建漂亮书籍的命令行工具(和Node.js库). GitBook 可以将您的内容作为网站(可定制和可扩 ...

Asciidoc语法

Asciidoc语法相关推荐

最新文章

热门文章