您现在的位置是：首页 > 网站制作 > 推荐工具推荐工具

程序员专属，记录笔记、文档、知识库的专属伙伴！——docz 最美分享Coder 2019/08/25 10:38:45

胜于蓝2019-10-16【推荐工具】人已围观

简介今天要介绍的是一个在Github上标星16k+的程序员专属文档工具——docz，官网对其概念就一句话，记录东西从未如此简单！Github坐标https://github.com/pedronauck/docz相

今天要介绍的是一个在Github上标星16k+的程序员专属文档工具——docz，官网对其概念就一句话，记录东西从未如此简单！3Ng胜于蓝|优秀个人博客

Github坐标

https://github.com/pedronauck/docz3Ng胜于蓝|优秀个人博客

相关特性

使用Gatsby构建

Docz自v2以来完全使用Gatsby构建，优化了闪电般的快速开发体验和构建时间，并拥有庞大的插件和工具生态系统。3Ng胜于蓝|优秀个人博客

零配置

无需担心构建和运行文档的复杂配置设置。使用Docz，您只需一个命令即可初始化您的应用程序。3Ng胜于蓝|优秀个人博客

易于定制

使用component shadowing，你可以轻松地为文档网站创建和修改主题3Ng胜于蓝|优秀个人博客

基于MDX

MDX是Markdown + JSX，为Markdown带来了组件世界。MDX可以在Markdown样式的文件中导入和使用您的组件。Docz充分利用了这一点，并提供了许多内置组件，可以增强和加快文档工作流程。3Ng胜于蓝|优秀个人博客

完全可插拔

插件一直是被允许的功能，灵活和优化应用程序的好方法。在Docz中，可以使用它们挂到Docz数据流并使用所有Gatsby插件来改进您的文档。3Ng胜于蓝|优秀个人博客

TypeScript支持

Docz为TSX组件和自定义类型提供完整的本机TypeScript支持。实际上，所有Docz包都是使用TypeScript构建的。有关更多信息，请查看API部分。3Ng胜于蓝|优秀个人博客

安装使用

1、安装依赖3Ng胜于蓝|优秀个人博客

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

2、在你项目任何想创建的地方，创建MDX文件3Ng胜于蓝|优秀个人博客

3、文档已经就绪，你只需要GO3Ng胜于蓝|优秀个人博客

yarn docz dev

PS：详细的用法和API请查阅官网文档，在此不再详细介绍3Ng胜于蓝|优秀个人博客

主题切换

Docz的一个主要功能是，您、可以从头开始创建自己的主题，只使用从Docz解析的数据。Docz本身提供了一系列组件，可以帮助你轻松创建自己的主题。3Ng胜于蓝|优秀个人博客

大概如下这样的一个项目结构：3Ng胜于蓝|优秀个人博客

创建主题组件3Ng胜于蓝|优秀个人博客

// src/gatsby-theme-docz/index.js
import React from 'react'
import { theme } from 'docz'
const Theme = ({ children }) => <div>{children}</div>
export default theme()(Theme)

默认主题配置3Ng胜于蓝|优秀个人博客

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)