Docz 开源项目教程
2024-09-16 10:21:31作者:薛曦旖Francesca
1、项目介绍
Docz 是一个用于快速创建和发布交互式文档的工具。它基于 MDX(Markdown + JSX),允许开发者轻松地编写和展示代码示例,并将其转换为生产就绪的文档站点。Docz 利用 GatsbyJS 和 Gatsby 主题阴影化技术,使得开发者可以自定义文档的外观、感觉和行为。
2、项目快速启动
安装依赖
首先,使用 Yarn 或 npm 将 Docz 添加到你的项目中:
yarn add docz # 或者使用 npm install docz
注意:react 和 react-dom 不会自动安装,你需要手动安装它们。
创建 MDX 文件
在你的项目中创建一个 .mdx 文件,例如 Button.mdx:
---
name: Button
route: /
---
import { Playground, Props } from 'docz'
import Button from './Button'
# Button
<Props of={Button} />
## 基本用法
<Playground>
<Button type="submit">Click me</Button>
<Button>No, click me</Button>
</Playground>
创建组件
创建一个 React 组件 Button.jsx:
import React from 'react'
import PropTypes from 'prop-types'
const Button = ({ children, type }) => (
<button type={type}>{children}</button>
)
Button.propTypes = {
/**
* 这是该属性的描述
* 按钮类型
*/
type: PropTypes.oneOf(['button', 'submit', 'reset']),
}
Button.defaultProps = {
type: 'button',
}
export default Button
启动开发服务器
运行以下命令启动本地开发服务器:
yarn docz dev
这将启动一个本地开发服务器,并在浏览器中打开你的文档站点。
构建文档站点
使用以下命令生成静态站点:
yarn docz build
生成的静态文件将位于 docz/dist/ 目录中。你可以使用 yarn docz serve 或任何静态文件服务器(如 npx serve docz/dist)来预览生成的站点。
3、应用案例和最佳实践
应用案例
- Welcome UI: 一个可定制的设计系统,使用 React、styled-components、styled-system 和 reakit。
- React Hooks Testing Library: 一个简单且完整的 React Hooks 测试工具,鼓励良好的测试实践。
- Mobx React: Mobx-react 文档站点。
最佳实践
- 使用 MDX: 利用 MDX 的强大功能,将 Markdown 和 JSX 结合,使文档更具交互性。
- 自定义主题: 通过 Gatsby 主题阴影化技术,自定义文档的外观和行为。
- SEO 优化: Docz 生成的文档站点是 SEO 友好的,确保你的文档在搜索引擎中表现良好。
4、典型生态项目
- GatsbyJS: 一个基于 React 的静态站点生成器,Docz 利用 GatsbyJS 来生成文档站点。
- MDX: 一个将 Markdown 和 JSX 结合的工具,使得文档编写更加灵活和强大。
- React: 一个用于构建用户界面的 JavaScript 库,Docz 基于 React 构建。
- styled-components: 一个用于样式化 React 组件的库,Docz 支持使用 styled-components 进行样式化。
通过这些模块的介绍和实践,你可以快速上手并充分利用 Docz 来创建和发布高质量的文档站点。
登录后查看全文
热门项目推荐
相关项目推荐
PaddleOCR-VLPaddleOCR-VL 是一款顶尖且资源高效的文档解析专用模型。其核心组件为 PaddleOCR-VL-0.9B,这是一款精简却功能强大的视觉语言模型(VLM)。该模型融合了 NaViT 风格的动态分辨率视觉编码器与 ERNIE-4.5-0.3B 语言模型,可实现精准的元素识别。Python00- DDeepSeek-OCRDeepSeek-OCR是一款以大语言模型为核心的开源工具,从LLM视角出发,探索视觉文本压缩的极限。Python00
openPangu-Ultra-MoE-718B-V1.1昇腾原生的开源盘古 Ultra-MoE-718B-V1.1 语言模型Python00
HunyuanWorld-Mirror混元3D世界重建模型,支持多模态先验注入和多任务统一输出Python00
AI内容魔方AI内容专区,汇集全球AI开源项目,集结模块、可组合的内容,致力于分享、交流。03
Spark-Scilit-X1-13B科大讯飞Spark Scilit-X1-13B基于最新一代科大讯飞基础模型,并针对源自科学文献的多项核心任务进行了训练。作为一款专为学术研究场景打造的大型语言模型,它在论文辅助阅读、学术翻译、英语润色和评论生成等方面均表现出色,旨在为研究人员、教师和学生提供高效、精准的智能辅助。Python00
GOT-OCR-2.0-hf阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile014
Spark-Chemistry-X1-13B科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
项目优选
收起
OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
260
2.52 K
deepin linux kernel
C
24
6
暂无简介
Dart
553
123
本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
595
131
Ascend Extension for PyTorch
Python
94
121
仓颉编程语言命令行工具,包括仓颉包管理工具、仓颉格式化工具、仓颉多语言桥接工具及仓颉语言服务。
C++
52
67
React Native鸿蒙化仓库
JavaScript
218
301
🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
1.02 K
600
仓颉编译器源码及 cjdb 调试工具。
C++
116
90
本仓将收集和展示高质量的仓颉示例代码,欢迎大家投稿,让全世界看到您的妙趣设计,也让更多人通过您的编码理解和喜爱仓颉语言。
Cangjie
357
1.77 K