GitBook AsciiDoc

2021-03-02 10:18 更新

從 2.0.0 版本起,GitBook 也能支持 AsciiDoc 作為輸入的格式。

關于這個格式的更多信息請參考 AsciiDoc Syntax Quick Reference。

和 markdown 一樣,GitBook 也使用了一些特殊的文件來提取書本的結構:README.adoc,SUMMARY.adoc 和 GLOSSARY.adoc。

README.adoc

這是書本的最重要項目:介紹。這個文件是必須的。

SUMMARY.adoc

這個文件定義了章節(jié)和子章節(jié)的列表。和 markdown 文件一樣,SUMMARY.adoc 的格式是簡單的鏈接列表,鏈接的名字是章節(jié)的名字,鏈接的目標是章節(jié)文件的路徑。

子章節(jié)被簡單的定義成添加到父章節(jié)的內嵌列表。

= Summary

. link:chapter-1/README.adoc[Chapter 1]
.. link:chapter-1/ARTICLE1.adoc[Article 1]
.. link:chapter-1/ARTICLE2.adoc[Article 2]
... link:chapter-1/ARTICLE-1-2-1.adoc[Article 1.2.1]
. link:chapter-2/README.adoc[Chapter 2]
. link:chapter-3/README.adoc[Chapter 3]
. link:chapter-4/README.adoc[Chapter 4]
.. Unfinished article
. Unfinished Chapter

LANGS.adoc

對于 多語言 書,這個文件是用來定義支持的語言和翻譯。

這個文件遵循 SUMMARY.adoc 一樣的語法:

= Languages

. link:en/[English]
. link:fr/[French]

GLOSSORY.adoc

這個文件是用來定義術語的。請查看 術語表 那章節(jié)。

= Glossary

== Magic
Sufficiently advanced technology, beyond the understanding of the observer producing a sense of wonder.

== PHP
+A popular web programming language, used by many large websites such as Facebook. Rasmus Lerdorf originally created PHP in 1994 to power his personal homepage (PHP originally stood for "Personal Home Page" but now stands for "PHP: Hypertext Preprocessor").


以上內容是否對您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號
微信公眾號

編程獅公眾號