Introduction

ruabick is documentation tool for developing libraries (based on VitePress)。The functional design was copied from dumi. But dumi currently does not support vue.

INFO

The predecessor of the project was vitepress-for-components

Motivation

VitePress is very fast and lightweight, but there is the following shortcomings under the scene of the component document:

1. The document and Demo have to be written twice.

Refer to dumi's demo-principle

2. Documentation, Demo and source code in different directories, The sense of contact is not strong.

The source code and Demo are usually in the src directory, but VitePress usually needs to create a new 'docs' directory, which should be in the same place.

Refer to dumi's directory structure

Introduction #

Motivation #

1. The document and Demo have to be written twice. #

2. Documentation, Demo and source code in different directories, The sense of contact is not strong. #

3. We need the function of automatically generate component API document. #

Introduction

Motivation

1. The document and Demo have to be written twice.

2. Documentation, Demo and source code in different directories, The sense of contact is not strong.

3. We need the function of automatically generate component API document.