[英]How to properly configure GitBook Space's README.md?
我正在使用 GitBook 的 GitLab 集成為我公司准備推出的產品創建文檔。 下面是來自 app.gitbook.com 的 git-sync'd Space 當前的樣子:
目前,我的項目根目錄中有以下文件:
usage-doc/
|
+-- README.md
+-- SUMMARY.md
+-- book.json
book.json
具有以下內容:
{
"title": "Usage Documentation",
"description": "Hello World"
}
我想解決的問題如下:
來自gitbook 文檔: Title of your book, default value is extracted from the README. On legacy.gitbook.com this field is pre-filled.
Title of your book, default value is extracted from the README. On legacy.gitbook.com this field is pre-filled.
但是,無論是我在README.md
中添加的標題,還是我在book.json
中設置的"title"
鍵,似乎都沒有被正確提取以顯示在 GitBook 空間中,您可以看到它仍然顯示為“ Untitled ”側邊欄,README 頁面顯示通用的“ README ”文本,而標題“___ Usage Documentation”顯示為下方的說明。
我想在自述文件頁面上添加另一個部分鏈接/快捷方式,在“買方”的“賣方”下方。 我該怎么做?
您所指的功能是關於 GitBook Legacy 的,這是 GitBook 多年來一直不支持的版本。 GitBook 現在是雲產品,官方文檔在這里: https://docs.gitbook.com 。
在您的示例中更改空間本身標題的方法是在頂部鍵入標題:“輸入此空間的標題”。 然后讓它同步。 Git 同步是雙向同步。 當您在 GitBook Space 中更改某些內容時,它會同步到 Git 存儲庫,反之亦然。
我想在自述文件頁面上添加另一個部分鏈接/快捷方式,在“買方”的“賣方”下方。 我該怎么做?
這是一個顯示頁面、組和鏈接的示例SUMMARY.md
文件:
# Table of contents
* [README](README.md)
* [Test](test.md)
## Group
* [Group](group/group.md)
***
* [My blog](https://petros.blog)
從空間本身添加頁面、組或鏈接的方法是通過更改請求。 也就是說,您需要單擊編輯來啟動新的更改請求。 這樣做之后,您將在左側邊欄中看到一個新頁面選項。 如果單擊該選項,您可以選擇要添加的內容。
聲明:本站的技術帖子網頁,遵循CC BY-SA 4.0協議,如果您需要轉載,請注明本站網址或者原文地址。任何問題請咨詢:yoyou2525@163.com.