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

    API

    查看源码
    (共 42 行)
    parseMarkdownList

    解析 Markdown 语法的列表

    参数
    参数名说明类型
    content

    要解析的内容

    string
    返回值
    类型:{items: MarkdownListItem[] // 已解析的列表rest: string // 剩余未解析的内容}

    查看源码
    (共 15 行)
    formatMarkdownList

    格式化 Markdown 语法的列表

    参数
    参数名说明类型
    items

    要格式化的目录项

    展开子属性
    • raw: string — 当前列表项的原始内容
    • indent: number — 当前列表项的缩进数
    • checked: boolean — 当前列表项是否被勾选
    • title: string — 当前列表项的标题
    • subtitle: string — 当前列表项的副标题
    • url: string — 当前列表项的地址
    • children: (Circular)MarkdownListItem[] — 所有子列表项
    MarkdownListItem[]
    (可选)indent

    使用的缩进字符串

    默认值:" ";

    string
    (可选)prefix

    在每行内容前插入的前缀

    默认值:"";

    string
    返回值
    类型:string

    查看源码
    (共 17 行)
    MarkdownListItem 接口

    表示一个列表项

    属性

    属性名说明类型
    raw

    当前列表项的原始内容

    string
    indent

    当前列表项的缩进数

    number
    title

    当前列表项的标题

    string
    checked(可选)

    当前列表项是否被勾选

    boolean
    subtitle(可选)

    当前列表项的副标题

    string
    url(可选)

    当前列表项的地址

    string
    children(可选)

    所有子列表项

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