简介
docz-theme-default 是一款基于 Docz 的默认主题，主要为开发者提供了一个易于使用、美观大方的文档生成工具。本教程旨在向前端开发者介绍如何使用 docz-theme-default 这一 npm 包，以及如何在项目中应用它。
安装
要使用 docz-theme-default 主题，我们首先需要安装 docz：
--- ------- ---- --
安装成功后，再安装 docz-theme-default：
--- ------- ------------------ --
使用
配置
要在项目中应用 docz-theme-default，需要在 .doczrc.js 配置文件中设置 theme 选项：
------ ------- - ------ --- ---- ------ ------ --------------------- --
编写文档
在 Docz 中，文档通常以 Markdown 文件的形式编写。如下是一个示例 Markdown 文件：
--- ----- ------ ----- ---------- --- - ------ ------ ----------- -- ---- ----- ------ - ------ - ---- ---------------------- ------- ----------- -- ----------------------------
Props
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| onClick | func | 点击事件 | |
| style | object | 样式对象 | |
| label | string | 按钮文本内容 |
------- ----- ---------------------- - ------------ - -------- ---- ------------ --- ----- ---------- ---- --- --------- -------------- --- ---- ---------------- ---- ------------------------- ---- ---- ---------------- -- ---- -------- -------------------- -----
my-docz-site/ ├── node_modules/ ├── src/ │ └── components/ │ └── Button/ │ ├── Button.js │ └── Button.md │ └── index.css ├── .docz/ ├── .doczrc.js ├── package.json └── README.md
------------ ----- ----- ------ ------- - ------ --- ---- ------ ------ --------------------- --
src/components/Button/Button.js 文件：
------ ----- ---- -------- ------ ----- ------ - -- -------- ------ ----- -- -- - ------ ------- ------------- ----------------------------------- --
src/components/Button/Button.md 文件：
--- ----- ------ ----- ---------- --- - ------ ------ ----------- -- ---- ----- ------ - ------ - ---- ---------------------- ------- ----------- -- ----------------------------
Props
| 属性名 | 类型 | 默认值 | 描述 |
|---|---|---|---|
| onClick | func | 点击事件 | |
| style | object | 样式对象 | |
| label | string | 按钮文本内容 |
---------------- ---- ------
npm run docz:dev
------- -------------------------------- ------------------------------------------------------------ ---------- -----------------------------------------------------------------------------------------