A tool help you generate documentation lightweight, seamless, fast and beautiful

Overview

Logo for project


npm package node compatibility TypeScript NPM Downloads

一个 轻量、飞快、美观 的 React 组件文档生成套件

English | 简体中文

Features

  • Vite 内核,高效极速的开发体验
  • 使用 Markdown 写法,让你快速为项目编写说明文档的同时,自动生成预览,在调试的同时生成文档
  • 自动分析 TypeScript 类型定义并生成 API 文档
  • 自动根据 .md 文件目录生成菜单导航
Markdown

Markdown

TypeScript Types

TypeScript Types

Usage & Guide

你可以查看 examples 目录下的项目,便于你快速开始使用。

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

More Details

You might also like...

This tool allows you to draw up plans for facilities from Foxhole's new Inferno update. It takes power and resource needs into account to help you efficiently design your facilities.

This tool allows you to draw up plans for facilities from Foxhole's new Inferno update. It takes power and resource needs into account to help you efficiently design your facilities.

Foxhole Facility Planner This tool allows you to draw up plans for facilities from Foxhole's new Inferno update. It takes power and resource needs int

Dec 23, 2022

Flutter makes it easy and fast to build beautiful apps for mobile and beyond

Flutter makes it easy and fast to build beautiful apps for mobile and beyond

Flutter is Google's SDK for crafting beautiful, fast user experiences for mobile, web, and desktop from a single codebase. Flutter works with existing

Jan 7, 2023

🍭 search-buddy ultra lightweight javascript plugin that can help you create instant search and/or facilitate navigation between pages.

🍭 search-buddy ultra lightweight javascript plugin that can help you create instant search and/or facilitate navigation between pages.

🍭 search-buddy search-buddy is an open‑source ultra lightweight javascript plugin (* 1kb). It can help you create instant search and/or facilitate n

Jun 16, 2022

A RESP 'Redis Serialization Protocol' library implementation to generate a server, uses a similar approach to express to define you serer, making it easy and fast.

A RESP 'Redis Serialization Protocol' library implementation to generate a server, uses a similar approach to express to define you serer, making it easy and fast.

RESPRESS A RESP 'Redis Serialization Protocol' library implementation to generate a server, uses a similar approach to express to define you serer, ma

Aug 29, 2022

BCash is an app to help you keep track of who you owe and who owes you money in an easy way. Split your tabs and more.

BCash BCash is an app to help you keep track of who you owe and who owes you money in an easy way. Split your tabs and more. Routes for develpment: lo

Aug 11, 2022

The website which can help you to organize your daily or weekly activities and review them when you need them. you can add, remove and delete an activity

To Do list To do project is webpack project that list activities someone can do at a specific time In this TO-DO list, you can add or remove you activ

Jul 21, 2022

"To-do list" is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark them as complete. You will build a simple website that allows for doing that, and you will do it using ES6 and Webpack!

To-do-list Description "To-do list" is a tool that helps to organize your day. It simply lists the things that you need to do and allows you to mark t

Oct 18, 2022

A web app which help you to save you a list of your favorite books, they will be saved on your local storage to never loose them even if you close the page. Built wiht JavaScript

Awesome Books In this project I build a page to save a list of your favorites books, you can add new books, delete it and they will be saved in the lo

Dec 17, 2022

FocusSpace - A time-management tool to help you stay focus with your friends

FocusSpace - A time-management tool to help you stay focus with your friends

FocusSpace 🏆 ElleHacks2022 - (Telus) First Place 👩 Developers Manyi Cheng(@man

Feb 13, 2022
Swagger UI is a collection of HTML, JavaScript, and CSS assets that dynamically generate beautiful documentation from a Swagger-compliant API.

Introduction Swagger UI allows anyone — be it your development team or your end consumers — to visualize and interact with the API’s resources without

Swagger 23.2k Dec 28, 2022
e-ONG, an authorial project, whose objective is to help ONGs to find people who need help or would like to help them

This project was bootstrapped with Create React App. Available Scripts In the project directory, you can run: npm start Runs the app in the developmen

Lucas Lima 2 Nov 11, 2022
JavaScript framework for creating beautiful, fast and lightweight websites based on flutter way of coding ☜(゚ヮ゚☜)

Welcome to Flutjs project ?? Flutjs is a javascript framework for creating beautiful, fast and lightweight websites. As the name suggests, Flutejs is

Filipe Lukebana 25 Nov 9, 2022
A magical vite plugin that helps you to generate and manage documentation website.

vite-plugin-book A magical vite plugin that helps you to generate and manage documentation website. ⚠️ This project is still WIP. It's a MVP now. A bu

Mirone 89 Dec 20, 2022
Types generator will help user to create TS types from JSON. Just paste your single object JSON the Types generator will auto-generate the interfaces for you. You can give a name for the root object

Types generator Types generator is a utility tool that will help User to create TS Interfaces from JSON. All you have to do is paste your single objec

Vineeth.TR 16 Dec 6, 2022
An opinionated tool to create beautiful, lightweight, static HTML/CSS practice quizzes

Taoquiz An opinionated tool to create beautiful, lightweight, static HTML/CSS practice quizzes "Perfection is achieved, not when there is nothing more

null 8 Mar 28, 2022
Generate rich documentation data for TypeScript and MDX codebases.

⚠️ Currently under development, not ready for use yet This library is currently unstable and the API is in flux. It is being worked on in the open for

Travis Arnold 16 Oct 30, 2022
Generate Stripe-like API Documentation

Generate Stripe-like API Documentation Get Started Today Table of contents Usage Inputs Contributing Licence Usage Start by creating a documentation o

Theneo 12 Sep 15, 2022
Snippets4Dummies is an easy to use Visual Code Extension which is used for building beautiful layouts as fast as your crush rejects you!

Why Snippets4Dummies? Snippets4Dummies is an easy to use Visual Code Extension which is used for building beautiful layouts as fast as your crush reje

SCHWITZ 6 Oct 11, 2022