GitBook GitCode Plugin

在您的 GitBook 中集成 GitCode 仓库链接的插件。

功能特性

• 🔗 在 GitBook 页面中显示 GitCode 仓库链接
• 🎨 美观的按钮样式
• ⚙️ 简单易用的配置
• 📱 响应式设计，支持移动端

安装

在您的 GitBook 项目中安装此插件：

npm install gitbook-plugin-gitcode

使用方法

在您的 book.json 文件中添加插件配置：

{
    "plugins": ["gitcode"],
    "pluginsConfig": {
        "gitcode": {
            "url": "https://gitcode.com/your-username/your-repository"
        }
    }
}

配置选项

| 选项 | 类型 | 必填 | 默认值 | 描述 | |------|------|------|--------|------| | url | string | 是 | - | 您的 GitCode 仓库 URL | | buttonText | string | 否 | "GitCode" | 按钮显示的文字 | | showText | boolean | 否 | true | 是否显示按钮文字 |

示例

基础配置

{
    "plugins": ["gitcode"],
    "pluginsConfig": {
        "gitcode": {
            "url": "https://gitcode.com/nutpi/gitbook-plugin-gitcode"
        }
    }
}

高级配置

{
    "plugins": ["gitcode"],
    "pluginsConfig": {
        "gitcode": {
            "url": "https://gitcode.com/nutpi/gitbook-plugin-gitcode",
            "buttonText": "查看源码",
            "showText": true
        }
    }
}

仅图标模式

{
    "plugins": ["gitcode"],
    "pluginsConfig": {
        "gitcode": {
            "url": "https://gitcode.com/nutpi/gitbook-plugin-gitcode",
            "showText": false
        }
    }
}

版本要求

• GitBook: >= 3.0.0
• Node.js: >= 6.0.0

开发

构建

npm run build-js

发布

npm run prepublish

授权

Apache-2.0 License

贡献者

• jianguo
• nutpi ([email protected])

相关链接

• GitCode 仓库