From 0180a444494f5db9e575d5206abe597ead5ebc51 Mon Sep 17 00:00:00 2001 From: exoego Date: Sun, 11 Nov 2018 11:09:50 +0900 Subject: [PATCH] Refer "Read More" feature in doc. --- README.md | 3 +++ docs/read-more-description.md | 24 ++++++++++++++++++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/read-more-description.md diff --git a/README.md b/README.md index 4232c2bb..fbd254ae 100644 --- a/README.md +++ b/README.md @@ -204,6 +204,9 @@ Also you may rewrite some predefined environment variables defined in [Dockerfil ### 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). +### "Read More" button +You can add "Read More" button that allows readers to continue reading more by adding `` into any place of your specification `description`. Check out details [here](docs/read-more-description.md). + ### Swagger vendor extensions 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 diff --git a/docs/read-more-description.md b/docs/read-more-description.md new file mode 100644 index 00000000..82cc304f --- /dev/null +++ b/docs/read-more-description.md @@ -0,0 +1,24 @@ +# "Read More" + +You can add "Read More" button into your operation `description` by adding a special comment tag `` (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. + + 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) +