Skip to content

Latest commit

 

History

History
135 lines (73 loc) · 6.31 KB

readme.md

File metadata and controls

135 lines (73 loc) · 6.31 KB

注:当前项目为 Serverless Devs 应用,由于应用中会存在需要初始化才可运行的变量(例如应用部署地区、函数名等等),所以不推荐直接 Clone 本仓库到本地进行部署或直接复制 s.yaml 使用,强烈推荐通过 s init ${模版名称} 的方法或应用中心进行初始化,详情可参考部署 & 体验

website-dumi-v3 帮助文档

本案例将 Dumi ,这一为 React 组件和库的开发者量身打造的文档生成器,快速创建并部署到阿里云函数计算 FC 。

前期准备

使用该项目,您需要有开通以下服务并拥有对应权限:

服务/业务 权限 相关文档
函数计算 AliyunFCFullAccess 帮助文档 计费文档

部署 & 体验

案例介绍

本案例将 Dumi ,这一为 React 组件和库的开发者量身打造的文档生成器,快速创建并部署到阿里云函数计算 FC 。

Dumi 与传统的文档工具不同,Dumi 不仅仅关注于文档内容的呈现,还提供了一套完善的开发环境,让开发者能够在编写文档的同时进行组件的开发和测试。它的设计理念是“在文档中开发,在开发中写文档”,通过这种方式融合了代码和文档的撰写流程。

在 GitHub 上,Dumi 受到了许多使用 React 的中文开发者的喜爱,并且拥有一定数量的 stars。它的易用性、灵活性以及优秀的本地化支持,使其成为中文社区中非常受欢迎的组件文档工具。

Dumi 的灵活性表现在它支持多种文档格式,包括 Markdown 和 JSX,开发者可以在 Markdown 中直接使用 React 组件,实现文档和演示的即时预览。此外,Dumi 提供了丰富的主题配置选项,可以帮助开发者快速构建符合自己品牌风格的文档网站。

作为一个开箱即用的工具,Dumi 支持自动生成导航和菜单,能够根据文件结构智能生成文档网站的布局。它还内置了代码高亮、实时编辑器等功能,让文档的呈现更加直观和互动。

通过 Serverless 开发平台,您只需要几步,就可以体验 Dumi ,并享受 Serverless 架构带来的降本提效的技术红利。

使用流程

查看部署的应用

本项目案例是 dumi 部署到阿里云 Serverless 平台(函数计算 FC),部署完成之后,您可以看到系统返回给您的案例地址,例如:

图片alt

此时,打开案例地址,就可以进入 dumi 默认的首页:

图片alt

二次开发

您可以通过云端控制台的开发功能进行二次开发。如果您之前是在本地创建的项目案例,也可以在本地项目目录website-dumi-v3文件夹下,对项目进行二次开发。开发完成后,可以通过s deploy进行快速部署。

注意事项

开发者社区

您如果有关于错误的反馈或者未来的期待,您可以在 Serverless Devs repo Issues 中进行反馈和交流。如果您想要加入我们的讨论组或者了解 FC 组件的最新动态,您可以通过以下渠道进行:

微信公众号:serverless 微信小助手:xiaojiangwh 钉钉交流群:33947367