在前端开发中，我们经常需要编写文档来记录代码的逻辑和使用方法。而一个好看、易读的文档主题则可以提高文档的可读性和用户体验。本文将介绍如何使用 npm 包 clean-documentation-theme 来为你的项目生成漂亮的文档。
什么是 clean-documentation-theme？
clean-documentation-theme 是一个基于 Gatsby 的主题，专门用于生成干净、简洁的文档页面。它支持 markdown 格式，并提供了许多自定义选项，方便你根据自己的需求进行调整。
安装
首先，你需要安装 Node.js 和 npm。接着，在你的项目目录下运行以下命令：
--- ------- ------ ----- --------- -------------------------
这会安装 Gatsby 和 clean-documentation-theme 以及其所依赖的 React 和 React-DOM。
配置
创建一个新的 Gatsby 项目：
--- ------ --- ------- ------------------------------------------------------
这会在当前目录下创建一个名为
my-docs的新项目，并使用 Gatsby 官方提供的 "Hello World" 模板。在项目根目录下创建一个
gatsby-config.js文件，并添加以下内容：-------------- - - ------------- - ------ --- --------------- ------------ -- ------------- ------- --- -- -------- -- -------- - - -------- ---------------------------- -------- - --------- -------- ------------ ---------- - - - --这里我们使用了
clean-documentation-theme的 Gatsby 插件。其中，basePath表示文档页面的根路径，contentPath则表示 markdown 文件所在的目录。你可以根据自己的需求进行调整，比如更改
title和description字段，或者添加其他插件和配置项。在
src/docs目录下创建一个名为index.md的文件，并添加一些示例内容：--- ------ -------- -------- ------------ -- ----- ----- ----- --- -- -------- --- - ------- ------- ---- -- - ----- ----- ----- --- -- -------- -- ------------ -- ------- --- -------- ----
npm install my-project
-- ----- -- --- --- -------- ------ -- --- ---- --- -------- ------------- ------ --------- ---- ------------- ----- -------- - --- ------------ -----------------------
That's it! There are many more features to explore, so be sure to check out the API documentation for details.
现在你已经完成了配置。接下来，执行以下命令启动 Gatsby 开发服务器：
------ -------
然后在浏览器中访问 http://localhost:8000/docs，即可看到生成的文档页面。
自定义
clean-documentation-theme 提供了许多自定义选项，方便你根据自己的需求进行调整。以下是一些常用的选项：
basePath: 文档页面的根路径，默认为/docscontentPath: markdown 文件所在的目录，默认为src/docslogo: 网站 logo 的路径或者 URLnavLinks: 导航栏链接列表footerText: 页面底部的文本内容
例如，要更改网站 logo，可以在 gatsby-config.js 中添加以下配置：
-------------- - -
-------- -
-
-------- ----------------------------
-------- -
----- -----------
----------------------------------------------------------- ----------
---------------------------------------------------------------------------------------