程序员专属,记录笔记、文档、知识库的专属伙伴!——docz( 二 )

使用component shadowing,你可以轻松地为文档网站创建和修改主题

基于MDX

MDX是Markdown + JSX,为Markdown带来了组件世界。MDX可以在Markdown样式的文件中导入和使用您的组件。Docz充分利用了这一点,并提供了许多内置组件,可以增强和加快文档工作流程。

完全可插拔

插件一直是被允许的功能,灵活和优化应用程序的好方法。在Docz中,可以使用它们挂到Docz数据流并使用所有Gatsby插件来改进您的文档。

TypeScript支持

Docz为TSX组件和自定义类型提供完整的本机TypeScript支持。实际上,所有Docz包都是使用TypeScript构建的。有关更多信息,请查看API部分。

安装使用

1、安装依赖

$ yarn add docz@next react react-dom --dev

2、在你项目任何想创建的地方,创建MDX文件

推荐阅读