vitdocjs/vitdoc

Use markdown to write documentation, and automatically extract interface definitions.

Based on Vite, use markdown to write React component documentation, and automatically extract component interface definitions.

Inspired by dumi、Histoire

English | 简体中文

Features

• Vite kernel, efficient and fast development experience.
• Using the Markdown writing, you can quickly write documentation for the project, automatically generate a preview, and generate documents while debugging.
• Automatically analyze TypeScript type definitions and generate API documentation.
• Automatically generate menu navigation based on .md file directory.

Write documentation by markdown

Extract ts interface

Usage & Guide

You can check out the projects in the examples directory for a quick start.

$ npm install -g vitdoc
$ cd ../examples/demo
$ vitdoc

More Details

• [Bilibili] Why do Vitdoc?
• [Article] Increase team performance by doing components
• [Article] Use Vite to make a react component inspiration

vitdoc's Issues

关于Demo无法正常运行的问题

环境: Windows 11
node版本: v16.15.1

按 README 步骤运行, 结果报错如下

怀疑可能是 Windows 系统原因吧, 希望大佬看一下, 很想上手体验一下!谢谢!

怎么规避预览区域内的样式污染

vitdoc: v1.8.8
@vitdoc/template-mobile: v2.2.1

目前预览区有 antd 的 reset.css，但实际项目并没有这些样式，会造成预览差异

请问有方法剔除或者预览区有纯空白文档提供吗？