配置文件说明 #

根目录下面的package.json文件。

{
    "name": "idoc",
    "version": "0.0.1",
    "description": "",
    "keywords": [
        ""
    ],
    "homepage": "http://JSLite.io",
    "author": "jaywcjlove <wowohoo@qq.com>",
    "repository": {
        "type": "git",
        "url": "https://github.com/jaywcjlove/idoc"
    },
    "licenses": "MIT",
    "idoc": {
        "theme": "default",
        "logo": "idoc-logo.svg",
        "md": [
            "首页.md",
            {
                "使用方法": [
                    "主题文件.md",
                    "初始化.md",
                    "配置说明.md"
                ]
            },
            "关于.md"
        ]
    }
}

参数说明 #

package.json 中内容有些是必须要的

name #

默认为文件夹名字

"name": "idoc"

repository #

跳转仓库按钮

在配置中 repository.url 取决于，默认主题文档右边是否显示 Fork me on GitHub 按钮。

"repository": {
    "type": "git",
    "url": "https://github.com/jaywcjlove/idoc"
}

idoc.logo #

默认皮肤支持设置logo图片显示

"idoc": {
    "logo": "idoc-logo.svg",
}

idoc.theme #

默认皮肤的名字为 default 。

"idoc": {
    "theme": "default"
}

菜单序列化 #

序列化 markdown 文档。这个是自动序列化的，您的操作只需要移动位置重新idoc build即可。

1. 默认在执行 idoc init 初始化的时候会序列化好菜单，如果 md 文件夹名字更改，或者名字更改，目前只能手动更改 package.json 对应 json 数据。
2. md数组的第一个为首页内容，每个文件均为菜单的名字。
3. 如果是下拉菜单放到文件夹中。

{
    "文件夹名字":[
        "markdown文件名字1",
        "markdown文件名字2",
        {
            "文件夹名字":[
                "markdown文件名字1",
                "markdown文件名字2",
                ...
            ]
        }
        ...
    ]
}