https://github.com/lexmin0412/readue

Readue, README 生成器。
https://github.com/lexmin0412/readue

cli readme readme-generator readue

Last synced: 3 months ago
JSON representation

Readue, README 生成器。

• Host: GitHub
• URL: https://github.com/lexmin0412/readue
• Owner: lexmin0412
• Created: 2024-04-15T13:07:08.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-07-12T09:09:41.000Z (about 1 year ago)
• Last Synced: 2024-10-13T21:54:15.834Z (12 months ago)
• Topics: cli, readme, readme-generator, readue
• Language: TypeScript
• Homepage: https://lexmin0412.github.io/readue/
• Size: 2.16 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

README

          
> 本文件由 [readue](https://github.com/lexmin0412/readue) 自动生成。

# readue

README 生成器。

## Packages

|子包|信息|说明|

|---|---|---|

|[@readue/api](https://www.npmjs.com/package/@readue/api)|![version](https://img.shields.io/npm/v/@readue/api)  ![downloads-month](https://img.shields.io/npm/dm/@readue/api)|Readue Node API|

|@readue/app|私有包, 未发布|Readue App, 提供 Readue 的可视化界面|

|[@readue/block-base_info](https://www.npmjs.com/package/@readue/block-base_info)|![version](https://img.shields.io/npm/v/@readue/block-base_info)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-base_info)|Readue 基础信息块插件|

|[@readue/block-env_requirement](https://www.npmjs.com/package/@readue/block-env_requirement)|![version](https://img.shields.io/npm/v/@readue/block-env_requirement)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-env_requirement)|Readue 环境要求块插件。|

|[@readue/block-packages](https://www.npmjs.com/package/@readue/block-packages)|![version](https://img.shields.io/npm/v/@readue/block-packages)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-packages)|Readue Monorepo 子包信息块|

|[@readue/block-star_history](https://www.npmjs.com/package/@readue/block-star_history)|![version](https://img.shields.io/npm/v/@readue/block-star_history)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-star_history)|Readue Star History 块插件|

|[@readue/block-techstack](https://www.npmjs.com/package/@readue/block-techstack)|![version](https://img.shields.io/npm/v/@readue/block-techstack)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-techstack)|Readue 技术栈块插件。|

|[@readue/block-tree](https://www.npmjs.com/package/@readue/block-tree)|![version](https://img.shields.io/npm/v/@readue/block-tree)  ![downloads-month](https://img.shields.io/npm/dm/@readue/block-tree)|Readue 文件树块插件。|

|[@readue/cli](https://www.npmjs.com/package/@readue/cli)|![version](https://img.shields.io/npm/v/@readue/cli)  ![downloads-month](https://img.shields.io/npm/dm/@readue/cli)|Readue 命令行接口。|

|[@readue/config](https://www.npmjs.com/package/@readue/config)|![version](https://img.shields.io/npm/v/@readue/config)  ![downloads-month](https://img.shields.io/npm/dm/@readue/config)|Readue 的配置包|

|@readue/docs|私有包, 未发布|Readue 文档|

## 项目结构

```bash

readue

├── CHANGELOG.md

├── README.md

├── changelog.config.js

├── lerna.json

├── package.json

├── packages

│   ├── api

│   ├── app

│   ├── block-base_info

│   ├── block-env_requirement

│   ├── block-packages

│   ├── block-star_history

│   ├── block-techstack

│   ├── block-tree

│   ├── cli

│   ├── config

│   └── docs

├── pnpm-lock.yaml

├── pnpm-workspace.yaml

└── tsconfig.json

```

## 环境要求

- node >=14.0.0

- pnpm >=8.0.0

## Star History

[![Star History Chart](https://api.star-history.com/svg?repos=lexmin0412/readue&type=Timeline)](https://star-history.com/#lexmin0412/readue&Timeline)