Markdown 高级功能

exportType 参数

SDoc 中的 markdown-loader 对 md 文件支持三种类型的导出,以支持在同一个MD文件中,导出文档 codeboxmarkdown 两部分内容组合。

使用方式通过md文件 exportType 的query参数来决定:

  • exportType=markdown:导出全部的 markdown 内容,不包括 codebox 标签内容;
  • exportType=component:只导出预览的 codebox 标签内容,不包括 markdown 内容;
  • 不加参数:导出全部 markdowncodebox 内容;

如下示例代码展示三种不同的导出情况。

import san from 'san';
import codeboxComponent from './codebox.md?exportType=component';
import codeboxMd from './codebox.md?exportType=markdown';
import codeboxAll from './codebox.md';

export default san.defineComponent({
    template: `<div>
        <h1>Markdown 高级配置</h1>
        <codebox-component/><hr>
        <codebox-md/><hr>
        <codebox-all/>
    </div>`,
    components: {
        'codebox-component': codeboxComponent,
        'codebox-md': codeboxMd,
        'codebox-all': codeboxAll
    }
});

index 参数

Markdown 存在多个 codebox 时,支持导出指定的 index

存在index时,默认导出类型(exportType)是 component,可省略。

<template>
    <div class="codebox-demo">
        <h3>来自`?exportType=component&index=0`</h3>
        <codebox-component1 />
        <hr />
        <h3>来自`?exportType=component&index=1`</h3>
        <codebox-component2 />
    </div>
</template>
<script>
    import codeboxComponent1 from './codebox.md?exportType=component&index=0';
    import codeboxComponent2 from './codebox.md?exportType=component&index=1';
    export default {
        components: {
            'codebox-component1': codeboxComponent1,
            'codebox-component2': codeboxComponent2
        }
    };
</script>