大家好,欢迎来到IT知识分享网。
介绍
今天要介绍的是一个在Github上标星16k+的程序员专属文档工具——docz,官网对其概念就一句话,记录东西从未如此简单!
Github坐标
https://github.com/pedronauck/docz
相关特性
- 使用Gatsby构建
Docz自v2以来完全使用Gatsby构建,优化了闪电般的快速开发体验和构建时间,并拥有庞大的插件和工具生态系统。
- 零配置
无需担心构建和运行文档的复杂配置设置。使用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文件
3、文档已经就绪,你只需要GO
yarn docz dev
PS:详细的用法和API请查阅官网文档,在此不再详细介绍
主题切换
Docz的一个主要功能是,您、可以从头开始创建自己的主题,只使用从Docz解析的数据。Docz本身提供了一系列组件,可以帮助你轻松创建自己的主题。
大概如下这样的一个项目结构:
创建主题组件
// src/gatsby-theme-docz/index.js import React from 'react' import { theme } from 'docz' const Theme = ({ children }) => <div>{children}</div> export default theme()(Theme)
默认主题配置
import React from 'react' import { theme } from 'docz' const Theme = ({ children }) => <div>{children}</div> const themeConfig = { colors: { primary: 'tomato', secondary: 'khaki', gray: 'lightslategray', }, } export default theme(themeConfig)(Theme)
作者提供了非常详细的文档和完整的示例,感兴趣的可以尝试一下
插件
docz提供了非常强大的插件机制,而且已经本身存在如下几个强大的插件
- docz-plugin-storybook
Docz插件,可以轻松地从Storybook迁移
- docz-plugin-netlify
将文档部署到Netlify
- docz-plugin-svg-sprite-loader
用于SVG加载器的Docz插件
- docz-plugin-snapshots
Docz的一个插件,可为所有记录的组件使用创建jest快照
总结
docz是一个非常值得尝试的文档工具,对于学习了react的开发者来说尤其友好,笔者在之前也介绍过很多文档工具,各有各的特色,再次在啰嗦一句,阿里的语雀和Docsite都是非常不错的笔记文档、知识库记录的利器,赶紧去试试吧!
免责声明:本站所有文章内容,图片,视频等均是来源于用户投稿和互联网及文摘转载整编而成,不代表本站观点,不承担相关法律责任。其著作权各归其原作者或其出版社所有。如发现本站有涉嫌抄袭侵权/违法违规的内容,侵犯到您的权益,请在线联系站长,一经查实,本站将立刻删除。 本文来自网络,若有侵权,请联系删除,如若转载,请注明出处:https://yundeesoft.com/79898.html