Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2025-08-08 06:04:56 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Favour Kelvin 2020-08-13 20:48:20 +01:00 committed by GitHub
parent 1fb73deae5
commit 8b708dedfb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
README.md
View File

@ -203,21 +203,21 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil
[ReDoc CLI](https://github.com/Redocly/redoc/blob/master/cli/README.md) tool is used to lint and bundle your OpenAPI definition(s) into **zero-dependency** HTML file. It can be installed as a development dependency in your project. [ReDoc CLI](https://github.com/Redocly/redoc/blob/master/cli/README.md) tool is used to lint and bundle your OpenAPI definition(s) into **zero-dependency** HTML file. It can be installed as a development dependency in your project.
## Create-openapi-repo ## Create-openapi-repo
[Create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool is used for splitting a single OpenAPI definition file into multiple files **compatible with version 3x only**. You can also use this tool to start a new API definition. [Create-openapi-repo](https://github.com/Redocly/create-openapi-repo) tool is used for splitting a single OpenAPI definition file into multiple files organized in folders **compatible with version 3x only**. You can also use this tool to start a new API definition and validate your OpenAPI definition.
## Community Edition(CE) vs Premium Edition(PE) ## Community Edition(CE) vs Premium Edition(PE)
Redocly offers two different editions: the [Community Edition (CE)](https://redoc.ly/redoc) and the [Premium Edition (PE)](https://redoc.ly/pricing). They offer the same easily deployable API documentation, fully supporting OpenAPI v2 and OpenAPI v3., but the difference is the limited features which is only available in the Premium Edition. Redocly offers two different editions: the [Community Edition (CE)](https://redoc.ly/redoc) and the [Premium Edition (PE)](https://redoc.ly/pricing). They offer the same easily deployable API documentation, fully supporting OpenAPI v2 and OpenAPI v3., but the difference is the limited features which is only available in the Premium Edition.
The [Redocly CE](https://redoc.ly/redoc) is free and open source and is aimed at developers and teams who are looking to create easily deployable API documentation. The [Redocly CE](https://redoc.ly/redoc) products are: The [Redocly CE](https://redoc.ly/redoc) is free and open source and is aimed at developers and teams who are looking to create easily deployable API documentation. The [Redocly CE](https://redoc.ly/redoc) products are:
* [Redoc](https://redoc.ly/redoc): simple to set up: no server required and fully customizable theme. * [Redoc](https://redoc.ly/redoc): simple to set up, no server required and fully customizable theme.
* [Openapi-cli](https://redoc.ly/openapi-cli): lint and bundle your OpenAPI definition(s) * [Openapi-cli](https://redoc.ly/openapi-cli): lint and bundle your OpenAPI definition(s).
* [Create-openapi-repo](https://github.com/Redocly/create-openapi-repo): write and start a new OpenAPI definition. * [Create-openapi-repo](https://github.com/Redocly/create-openapi-repo): write and start a new OpenAPI definition.
The [Redocly PE](https://redoc.ly/pricing) comes in the starter versions and the paid versions. The [Redocly PE](https://redoc.ly/pricing)products are: The [Redocly PE](https://redoc.ly/pricing) comes in the starter versions and the paid versions. The [Redocly PE](https://redoc.ly/pricing)products are:
* [API Reference](https://redoc.ly/reference-docs): easily create, style, and manage your API documentation with advanced developer friendly features * [API Reference Docs](https://redoc.ly/reference-docs): easily create, style, and manage your API documentation with advanced developer friendly features.
* [Developer Portal (Beta)](https://redoc.ly/developer-portal): where docs-as-code meets docs-as-marketing * [Developer Portal (Beta)](https://redoc.ly/developer-portal): where docs-as-code meets docs-as-marketing.
* [Workflows](https://redoc.ly/workflows): build, maintain, and automatically update your API documentation in the cloud * [Workflows](https://redoc.ly/workflows): build, maintain, and automatically update your API documentation in the cloud.
## Configuration ## Configuration
@ -295,12 +295,12 @@ Redocly has a variety of products, this table shows an overview of all Redocly p
| Tools | Description | Edition | | Tools | Description | Edition |
| :------------- | :---------- | :----------- | | :------------- | :---------- | :----------- |
| Redoc | The API reference documentation output from the OpenAPI definition. This free version has limited functionality. | Community Edition | | Redoc | The API reference documentation output from the OpenAPI definition. This edition has limited functionality. | Community Edition |
| create-openapi-repo | CLI tool for splitting a single OpenAPI definition file into multiple files (compatible with version 3x only). You can also use this CLI tool to start a new API definition. | Community Edition | | create-openapi-repo | CLI tool for splitting a single OpenAPI definition file into multiple files, start a new API definition, validating your OpenAPI definition, and other features. | Community Edition |
| openapi-cli | CLI tool that provides linting against a customizable ruleset, as well as bundling of the OpenAPI files into a single file. You can also preview the output of your docs with the Redocly API References through this tool. | Community Edition | | openapi-cli | CLI tool that provides linting against a customizable rules, as well as bundling of the OpenAPI files into a single file. You can also preview the output of your docs with the Redocly API References through this tool. | Community Edition |
| Redocly API Reference | The premium version of Redoc – the API reference documentation output from the OpenAPI definition file. This premium version includes Try-it functionality, enhanced search, fast loading, special tags, and other features. | Premium Editon | | API Reference Docs | The premium version of Redoc – the API reference documentation output from the OpenAPI definition file. This premium version includes Try-it functionality, enhanced search, fast loading, special tags, and other advanced features. | Premium Editon |
| Developer Portal (beta) | A sample `starter` developer portal, built on top of Gatsby. Intended for more robust documentation scenarios. | Premium Editon | | Developer Portal (beta) | A sample `starter` developer portal, built on top of Gatsby. Intended for more robust documentation such as landing pages, how-to guides, tutorials and so much more. | Premium Editon |
| Workflows | A online Redocly app that provides the full authoring and publishing toolset in the cloud, with GitHub integration and docs-as-code worflows | Premium Editon | | Workflows | An online Redocly app that provides the full authoring and publishing toolset in the cloud, with GitHub, Gitlab, Azure and Bitbucket integration and docs-as-code worflows. | Premium Editon |
## Join Us ## Join Us
**WE'RE HIRING!** Love APIs and working with distributed teams? Learn more about our [open positions](https://redoc.ly/careers) **WE'RE HIRING!** Love APIs and working with distributed teams? Learn more about our [open positions](https://redoc.ly/careers)