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

Refer "Read More" feature in doc.

Browse Source
This commit is contained in:
exoego 2018-11-11 11:09:50 +09:00
parent 884031b60c
commit 0180a44449
2 changed files with 27 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@ -204,6 +204,9 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil
### Security Definition location ### Security Definition location
You can inject Security Definitions widget into any place of your specification `description`. Check out details [here](docs/security-definitions-injection.md). You can inject Security Definitions widget into any place of your specification `description`. Check out details [here](docs/security-definitions-injection.md).
### "Read More" button
You can add "Read More" button that allows readers to continue reading more by adding `<!-- READMORE -->` into any place of your specification `description`. Check out details [here](docs/read-more-description.md).
### Swagger vendor extensions ### Swagger vendor extensions
ReDoc makes use of the following [vendor extensions](http://swagger.io/specification/#vendorExtensions): ReDoc makes use of the following [vendor extensions](http://swagger.io/specification/#vendorExtensions):
* [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo * [`x-logo`](docs/redoc-vendor-extensions.md#x-logo) - is used to specify API logo

24
docs/read-more-description.md Normal file
View File

@ -0,0 +1,24 @@
# "Read More"
You can add "Read More" button into your operation `description` by adding a special comment tag `<!-- READMORE -->` (case-sensitive).
```markdown
paths:
'/pet/{petId}/uploadImage':
post:
tags:
- pet
summary: uploads an image
description: |
Lorem ipsum dolor sit amet, ne mei mentitum conceptam, no vis saepe commune, idque minimum periculis his et. Sit etiam animal honestatis no, vide interpretaris id quo. Ea odio tincidunt mei, quo id eros persecuti. An quot facete malorum ius, sea ne decore iisque.
<!-- READMORE -->
Mei at eros assentior, usu ullamcorper mediocritatem no. Augue minimum ea per. Ne cum veniam lobortis sadipscing, ad sit amet docendi. Et delenit iracundia vix, vel ex vero legendos antiopam, et eam modo populo.
Eu dicat legere quo, facilisi theophrastus eam te. Nisl aeque adipisci cum id, debet reformidans ea mel. Nec ut commodo facilisis abhorreant. Ut homero consul
...
```
![Read More](https://user-images.githubusercontent.com/127635/48308178-8ba2d580-e5a1-11e8-8cdf-10808d4822e5.gif)