0
点赞
收藏
分享

微信扫一扫

十分钟学会制作一个漂亮的在线文档


官网地址:​​dumi - 为组件开发场景而生的文档工具 - dumi​​

​​一、项目简介​​

​​二、项目特点​​

​​三、快速入门 ​​

​​ (1)新建一个目录​​

​​(2)初始化组件库开发脚手架​​

​​(3)安装依赖​​

​​(4)启动项目​​

​​四、项目预览​​

一、项目简介

📖 为组件开发场景而生的文档工具 

二、项目特点

(1)开箱即用:考究的默认配置和约定式的目录结构,帮助开发者零成本上手,让所有注意力都能放在文档编写和组件开发上

(2) 为组件开发而生:丰富的 Markdown 扩展,不止于渲染组件 demo,使得组件的文档不仅易于编写、管理,还好看、好用

(3)主题系统:渐进式的自定义主题能力,小到扩展自己的 Markdown 标签,大到自定义完整主题包,全由你定

(4)API 自动生成:可基于 TypeScript 类型定义自动生成组件 API,组件永远『表里如一』

(5)移动端组件库研发:安装主题包即可快速启用移动端组件研发能力,内置移动端高清渲染方案

(6)资产数据化能力:一行命令将组件资产数据化,标准化的资产数据可与下游生产力工具串联

三、快速入门 

首先得有 ​​node​​,并确保 node 版本是 10.13 或以上。

 (1)新建一个目录

mkdir myapp && cd myapp

(2)初始化组件库开发脚手架

npx @umijs/create-dumi-lib

(3)安装依赖

npm i

(4)启动项目

npm start

四、项目预览

启动完成之后,访问地址:​​http://localhost:8000/​​

十分钟学会制作一个漂亮的在线文档_dumi

 这里只做一个简单入门指南,更多相关配置,请阅读官网文档教程。

举报

相关推荐

0 条评论