gitbook 入門教程之一招完全解決 favicon 圖標失效問題

時間 2019-11-24

標籤 gitbook 入門教程一招完全解決 favicon 圖標失效問題欄目 Git 简体版

原文原文鏈接

favicon-absolute 項目

favicon-absolute 插件採用絕對路徑設置網站 favicon 圖標,相對於相對路徑來講更加簡單方便.git

🏠 主頁

Github : snowdreams1006.github.io/gitbook-plu…
Gitee : snowdreams1006.gitee.io/gitbook-plu…
GitLab: snowdreams1006.gitlab.io/gitbook-plu…

效果

用法

Step #1 - 更新 `book.json` 配置文件

在 book.json 配置文件中,添加 favicon-absolute 到 plugins 列表.
在 book.json 配置文件中,配置 pluginsConfig 節點的 favicon-absolute 對象.

{
    "plugins": ["favicon-absolute"],
    "pluginsConfig": {
    	"favicon-absolute":{
            "favicon": "/favicon.ico",
            "appleTouchIconPrecomposed152": "/apple-touch-icon-precomposed-152.png"
        }
    }
}
複製代碼

其中,配置參數含義以下:github

"favicon": {
	"type": "string",
	"required": true,
	"default": "/favicon.ico",
	"title": "網頁圖標",
	"description": "網頁打開時顯示圖標"
},
"bookmark": {
	"type": "string",
	"required": false,
	"title": "收藏夾圖標",
	"description": "網頁被收藏時顯示圖標"
},
"appleTouchIcon152": {
	"type": "string",
	"required": false,
	"title": "Apple 設備152*152觸摸圖標",
	"description": "Apple 設備觸摸時152*152觸摸顯示圖標"
},
"appleTouchIconPrecomposed152": {
	"type": "string",
	"required": true,
	"default": "/apple-touch-icon-precomposed-152.png",
	"title": "Apple 設備152*152觸摸高亮圖標",
	"description": "Apple 設備觸摸時152*152高亮顯示圖標"
},
"appleTouchIconMore": {
	"type": "object",
	"required": false,
	"title": "Apple 設備自定義尺寸觸摸圖標",
	"description": "Apple 設備觸摸時自定義尺寸觸摸顯示圖標"
},
"appleTouchIconPrecomposedMore": {
	"type": "object",
	"required": false,
	"title": "Apple 設備自定義尺寸觸摸高亮圖標",
	"description": "Apple 設備觸摸時自定義尺寸高亮顯示圖標"
}
複製代碼

上述圖標位置建議直接放在根目錄下,這樣就會以絕對路徑形式訪問,解決相對路徑可能設置無效的問題.npm

Step #2 - 運行 gitbook 相關命令

運行 gitbook install 命令安裝到本地項目

$ gitbook install
複製代碼

或者json

npm install gitbook-plugin-favicon-absolute
複製代碼

運行 gitbook build 命令構建本地項目或者 gitbook serve 啓動本地服務.

$ gitbook build
複製代碼

或者bash

$ gitbook serve
複製代碼

示例

不只 gitbook-plugin-favicon-absolute 官方文檔已整合 favicon-absolute 版權保護插件,此外還提供了示例項目,詳情參考 example 目錄.app

官方文檔

{
    "title": "favicon-absolute 插件官方文檔",
    "author": "snowdreams1006",
    "description": "gitbook-plugin-favicon-absolute 插件官方文檔",
    "plugins": [
        "favicon-absolute"
    ],
    "pluginsConfig": {
    	"favicon-absolute":{
            "favicon": "/favicon.ico",
            "bookmark": "/bookmark.ico",
            "appleTouchIcon152": "/apple-touch-icon-152.png",
            "appleTouchIconPrecomposed152": "/apple-touch-icon-precomposed-152.png",
            "appleTouchIconMore": {
                "120x120": "/apple-touch-icon-120.png",
                "180x180": "/apple-touch-icon-180.png"
            },
            "appleTouchIconPrecomposedMore": {
                "120x120": "/apple-touch-icon-precomposed-120.png",
                "180x180": "/apple-touch-icon-precomposed-180.png"
            }
        }
    }
}
複製代碼

官方示例

{
    "title": "favicon-absolute 插件官方簡單示例",
    "author": "snowdreams1006",
    "description": "gitbook-plugin-favicon-absolute 插件官方簡單示例",
    "plugins": [
        "favicon-absolute"
    ],
    "pluginsConfig":{
        "favicon-absolute":{
            "favicon": "favicon.ico",
            "appleTouchIconPrecomposed152": "apple-touch-icon-precomposed-152.png"
        }
    }
}
複製代碼