dumi 使用指南

dumi 使用指南

dumi Static Site Generator for component library development 项目地址: https://gitcode.com/gh_mirrors/du/dumi

1. 项目基础介绍

dumi 是一个为组件库开发设计的静态站点生成器。它可以帮助开发者快速搭建和展示组件库文档。dumi 使用起来简单方便，能够很好地与 React 等前端框架集成。本项目主要使用 JavaScript 和 TypeScript 进行开发。

2. 关键技术和框架

• React: 用于构建用户界面的 JavaScript 库。
• TypeScript: 是 JavaScript 的一个超集，添加了静态类型选项。
• Markdown: 用于编写文档的轻量级标记语言。
• Webpack: 一个用于现代 JavaScript 应用程序的静态模块打包器。

3. 安装和配置

准备工作

在开始之前，请确保您的系统中已安装以下依赖：

• Node.js（推荐使用 LTS 版本）
• npm 或者 yarn

安装步骤

1. 克隆项目

   首先，您需要从 GitHub 上克隆 dumi 的仓库到本地：

   git clone https://github.com/umijs/dumi.git
   

2. 安装依赖

   进入到项目目录中，安装项目依赖：

   cd dumi
   npm install
   

   或者如果您使用 yarn：

   yarn
   

3. 启动开发服务器

   安装完成后，您可以使用以下命令启动本地开发服务器：

   npm run start
   

   或者使用 yarn：

   yarn start
   

   执行上述命令后，开发服务器将启动，并且通常会自动在默认的网络浏览器中打开一个新标签页，地址通常是 http://localhost:8000。

4. 构建项目

   当您完成开发工作后，可以使用以下命令构建项目，以生成用于生产的静态文件：

   npm run build
   

   或者使用 yarn：

   yarn build
   

   构建完成后，生成的静态文件将位于项目中的 dist 目录。

5. 部署

   构建完成后，您可以将 dist 目录中的文件部署到任何静态网站托管服务上，例如 GitHub Pages、Netlify 或 Vercel。

以上就是 dumi 的基础安装和配置指南。按照这些步骤，您应该能够成功搭建和运行 dumi 项目。

dumi Static Site Generator for component library development 项目地址: https://gitcode.com/gh_mirrors/du/dumi