Skip to content

Commit

Permalink
docs: add Documentation to README
Browse files Browse the repository at this point in the history
  • Loading branch information
why520crazy committed Mar 27, 2024
1 parent 3ef031c commit e2f89c5
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 15 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ APIs consistent with angular style, currently only supports Angular, other frame

English | [中文文档](https://github.com/worktile/ngx-planet/blob/master/README.zh-CN.md)

## Features
## Features

- Rendering multiple applications at the same time
- Support two mode, coexist and default that switch to another app and destroy active apps
Expand All @@ -25,6 +25,14 @@ English | [中文文档](https://github.com/worktile/ngx-planet/blob/master/READ
- Cross application component rendering
- Comprehensive examples include routing configuration, lazy loading and all features

## 📖 Documentation
- [Introduce](http://planet.ngnice.com/guides/intro)
- [Getting Started](http://planet.ngnice.com/guides/getting-started)
- [Development and Build](http://planet.ngnice.com/guides/dev-build)
- [Data shared and Communication](http://planet.ngnice.com/guides/communication)
- [Cross Application Component rendering](http://planet.ngnice.com/guides/cross-app-comp-rendering)
- [API References](http://planet.ngnice.com/guides/api)

## Alternatives

- [single-spa](https://github.com/CanopyTax/single-spa): A javascript front-end framework supports any frameworks.
Expand All @@ -38,13 +46,9 @@ $ npm i @worktile/planet --save
$ yarn add @worktile/planet
```

## Dependencies

- `<= 14.0.0` you should install `@angular/cdk`

## Demo

[Try out our live demo](http://planet.ngnice.com)
[Try out our live demo](http://planet-examples.ngnice.com)

![ngx-planet-micro-front-end.gif](https://cdn.pingcode.com/open-sources/ngx-planet/ngx-planet-micro-front-end.gif)

Expand Down
18 changes: 11 additions & 7 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Angular 的 API 风格,目前只支持 Angular 框架,不支持其他 MV*

中文文档 | [English README](https://github.com/worktile/ngx-planet/blob/master/README.md)

## 功能
## 功能

- 支持同时渲染多个子应用
- 支持并存(coexist)和默认(default)两种模式, 默认模式切换其他子应用销毁当前子应用,并存模式不会销毁,而是隐藏
Expand All @@ -24,6 +24,15 @@ Angular 的 API 风格,目前只支持 Angular 框架,不支持其他 MV*
- 支持跨应用组件的渲染
- 完善的示例,包含路由配置、懒加载等所有功能


## 📖 Documentation
- [介绍](http://planet.ngnice.com/guides/intro)
- [快速开始](http://planet.ngnice.com/guides/getting-started)
- [开发与构建](http://planet.ngnice.com/guides/dev-build)
- [数据共享与通信](http://planet.ngnice.com/guides/communication)
- [跨应用渲染](http://planet.ngnice.com/guides/cross-app-comp-rendering)
- [API 引用](http://planet.ngnice.com/guides/api)

## 其他方案

- [single-spa](https://github.com/CanopyTax/single-spa): A javascript front-end framework supports any frameworks.
Expand All @@ -37,14 +46,9 @@ $ npm i @worktile/planet --save
$ yarn add @worktile/planet
```

## Dependencies

-`<= 14.0.0`,确保安装了 Angular 官方的 CDK `npm i @angular/cdk --save` 或者 `yarn add @angular/cdk`


## 示例

[Try out our live demo](http://planet.ngnice.com)
[Try out our live demo](http://planet-examples.ngnice.com)

![ngx-planet-micro-front-end.gif](https://cdn.pingcode.com/open-sources/ngx-planet/ngx-planet-micro-front-end.gif)

Expand Down
7 changes: 5 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hero:
link: guides/getting-started
btnShape: round
features:
- icon: https://cdn.pingcode.com/open-sources/docgeni/home/feature4.png
- icon: https://cdn.pingcode.com/open-sources/docgeni/home/feature1.png
title: 开箱即用
description: 内置 Angular 应用路由同步、应用生命周期管理等微前端架构下的难点解决方案
- icon: https://cdn.worktile.com/open-sources/ngx-tethys/home/feature5.png
Expand All @@ -20,9 +20,12 @@ features:
- icon: https://cdn.worktile.com/open-sources/ngx-tethys/home/feature6.png
title: 稳定可用
description: 采用 Planet 微前端架构搭建的企业级应用的 PingCode 产品稳定上线多年,满足复杂交互的业务系统
- icon: https://cdn.worktile.com/open-sources/ngx-tethys/home/feature4.png
- icon: https://cdn.pingcode.com/open-sources/docgeni/home/feature4.png
title: 功能全面
description: 支持同时渲染多个应用、并存模式、预加载、样式/沙箱隔离、跨应用通信和组件渲染等高级功能
- icon: https://cdn.worktile.com/open-sources/ngx-tethys/home/feature4.png
title: 示例丰富
description: 提供包含完几乎所有功能的整示例,项目配置以及功能实现,同时提供详细的文档介绍所有特性
footer: Open-source MIT Licensed | Copyright © 2020-present<br />Powered by PingCode
---

Expand Down

0 comments on commit e2f89c5

Please sign in to comment.