0.0.1-alpha.2
  • 编辑此页(E)
  • 报告 BUG(B)
  • 查看源码(V)
  • 单元测试(U)

    • Index

    xuld
    2020/11/9(#1, xuld)

    API

    查看源码
    (共 8 行)    default异步默认导出

    参数
    参数名说明类型
    optionsany[]
    返回值
    类型：Promise<void>

    查看源码
    (共 1 行)    description只读

    类型："自动生成索引"

    查看源码
    (共 83 行)    generateIndex异步

    生成或更新索引文件夹

    参数
    参数名说明类型
    dir

    根文件夹

    		string
    update

    是否重新从目录项读取标题

    		boolean
    add

    是否扫描并添加不存在的目录项

    		boolean
    remove

    是否删除不存在的目录项

    		boolean
    返回值
    类型：Promise<{builder: Builderdir: stringdata: {autoGenerated: booleanpath: stringdependencies: (string | DependencyCallback)[]header: stringtitle: stringbody: stringitems: MarkdownListItem[]}created: booleanadded: numberupdated: numberremoved: number}>

    查看源码
    (共 8 行)    findContainer

    参数
    参数名说明类型
    items
    展开子属性
    • raw: string — 当前列表项的原始内容
    • indent: number — 当前列表项的缩进数
    • checked: boolean — 当前列表项是否被勾选
    • title: string — 当前列表项的标题
    • subtitle: string — 当前列表项的副标题
    • url: string — 当前列表项的地址
    • children: (Circular)MarkdownListItem[] — 所有子列表项
    		MarkdownListItem[]
    urlstring
    返回值
    类型：MarkdownListItem[]