【原创】Gitbook使用

【常用命令】

1.gitbook install

安装依赖模块

 

2.gitbook build

编译，结果输出在_book文件夹下

 

3.gitbook serve

本机预览，默认端口为4000

 

【注意事项】

1.图片文件名不能带中文

后果：图片不能显示。

 

2.根目录只能有两个MD文件

后果：如果根目录存在除了README.md和SUMMARY.md之外的md文件，点击README.md对应的菜单会无法正常跳转。

 

3.建议图片、视频上下文各保留一行空行

后果：图片或视频与文字之间没有换行，格式错乱。

 

4.SUMMARY.md的同一菜单最好放在相同目录下（拖动菜单位置可能会导致目录错乱），删除无用的md文件（菜单创建后删除不会自动删除文件）

后果：方便管理，减少垃圾文件，减少出现不可预料错误的可能性。

 【其他】

1.修改首页链接

默认README.md的链接为“./”，但有的时候不能指向默认的index.html文件。

修改文件：C:\Users\{用户名}\.gitbook\versions\{版本号}\lib\output\helper\fileToURL.js

修改为下面内容（注释掉三行）

function fileToURL(output, filePath) {
    var options = output.getOptions();
    var directoryIndex = options.get('directoryIndex');

    filePath = fileToOutput(output, filePath);

    /*if (directoryIndex && path.basename(filePath) == 'index.html') {
        filePath = path.dirname(filePath) + '/';
    }*/

    return LocationUtils.normalize(filePath);
}

修改后，再使用gitbook build后的首页链接就是“./index.html”

 2.build时出错，“gitbook Error: ENOENT: no such file or directory, stat........xxx.css”

参考链接：https://segmentfault.com/q/1010000009569245

修改文件：C:\Users\{用户名}\.gitbook\versions\{版本号}\lib\output\website\copyPluginAssets.js

修改112行（最下面），如下：

    ......
    logger.debug.ln('copy resources from plugin', assetsFolder);

    return fs.copyDir(
        assetsFolder,
        assetOutputFolder,
        {
            deleteFirst: false,
            overwrite: true/*,
            confirm: true*/
        }
    );
}

module.exports = copyPluginAssets;

 

转载于:https://www.cnblogs.com/abcdefghijklmnopqrstuvwxyz/p/8674805.html