Swapnil Ogale
0f53f4b208
Merge pull request #1748 from HCloward/docs/more-readme-updates
...
[GSoD]Updates readme with about section and organizes features list
2021-10-11 10:37:02 +11:00
Heather Cloward
c4564de324
Updates image src
2021-10-09 14:46:36 -04:00
Heather Cloward
3cc6ea4589
Minor edit
2021-10-09 14:44:37 -04:00
Heather Cloward
1c8578ea88
Adds comparison table and OpenAPI link section
2021-10-09 14:40:39 -04:00
Heather Cloward
8d93021f17
Minor edits
2021-09-22 22:20:49 -04:00
Heather Cloward
86907bd7ae
Merge branch 'docs/more-readme-updates' of github.com:HCloward/redoc into docs/more-readme-updates
2021-09-22 22:17:36 -04:00
Heather Cloward
669adddc9d
Updates per reviews and adds new logo
2021-09-22 22:17:19 -04:00
Ivana Isadora Devcic
c87600d520
fix: Redoc spelling
2021-09-21 22:17:48 +02:00
Mark Theisen
bd9390a5bf
feat: new option generatedPayloadSamplesMaxDepth ( #1642 )
2021-09-14 13:08:50 +03:00
Heather Cloward
899d7f9637
Adds some notes to deployment
2021-09-13 07:22:18 -04:00
Heather Cloward
f8925facf8
Updates readme with about section and organizes features list
2021-09-12 21:41:29 -04:00
Swapnil Ogale
e7f7d963bd
Update README.md
...
Co-authored-by: Adam Altman <adam@rebilly.com>
2021-09-01 22:03:57 +10:00
Ivana Isadora Devcic
a7ed8ddd98
Apply suggestions from code review
2021-09-01 13:48:46 +02:00
Heather Cloward
8afcf1b932
Removes content that is now in documentation and adds link to docs
2021-08-29 21:27:18 -04:00
Marius Butuc
836c422262
docs: add real-life usage example: BoxKnight ( #1651 )
2021-07-30 11:19:41 +03:00
Roman Hotsiy
c09cf9dbbe
chore: modernize build pipeline ( #1635 )
2021-06-09 14:57:36 +03:00
Andriy Leliv
44152fdae7
docs: update specUrl ( #1577 )
2021-04-12 21:26:00 +03:00
Kurt Furbush
e5644ee67a
docs: remove extra word in grammar ( #1539 )
2021-03-31 15:52:45 +03:00
迷渡
4846259de3
docs: minor syntax highlight fix on the README ( #1549 )
2021-03-02 09:35:28 +02:00
Oleksiy Kachynskyy
6086c6c89f
docs: remove outdated config option from readme ( #1543 )
2021-02-22 15:50:33 +02:00
romanhotsiy
755a9095f5
chore: update travis badge url
2021-01-30 23:36:10 +02:00
Karl Scheirer
a5e8e818c8
docs: document theme options ( #1438 )
2021-01-08 14:05:10 +02:00
jabba-jedi
f0755a804f
docs: fix the Rebilly link
2020-12-10 12:38:12 +02:00
Roman Hotsiy
2a329c1bec
docs: fix menuToggle default value
...
fixes #1476
[ci skip]
2020-12-01 15:24:20 +02:00
Anna Stasiuk
bb4594ee58
feat: add new option hideSchemaPattern ( #1475 )
...
* feat: add new option hideSchemaPattern
* chore: add hideSchemaPattern option to readme
2020-11-30 11:54:46 +02:00
Karl Scheirer
64b01162dc
docs: add 3 vendor extensions to list ( #1457 )
2020-11-10 10:21:02 +02:00
Hleb Albau
7ffaf9ff72
docs: add 'maxDisplayedEnumValues' option to docs ( #1421 )
2020-10-27 10:54:08 +02:00
David Goss
086302bb23
docs: unqualify mobx version for react usage ( #1380 )
...
Per https://github.com/Redocly/redoc/issues/1189#issuecomment-606857342 the latest version works now, and the currently-specified version doesn't.
2020-10-13 14:56:53 +03:00
Roman Hotsiy
7af2efe731
feat: new option simpleOneOfTypeLabel
2020-08-04 12:21:58 +03:00
Roman Hotsiy
becc2f5856
fix: depreacate x-code-samples, rename to x-codeSamples for consistency
2020-05-10 22:11:01 +03:00
Roman Hotsiy
afc7a95f13
docs: update usages examples
2020-03-17 16:46:43 +02:00
Roman Hotsiy
a24142b3fa
chore: migrate yarn -> npm
2020-03-17 11:06:03 +02:00
Roman Hotsiy
7608800d0a
feat: new option expandSingleSchemaField
2020-03-16 16:58:28 +02:00
Roman Hotsiy
eaaa99d68e
feat: new option payloadSampleIdx
2019-12-12 19:12:50 +02:00
bwjohnson-ss
7cabd4b90d
docs: fix link to x-nullable docs from README ( #1135 )
2019-12-10 08:03:46 +02:00
Alex
8bfa364010
docs: improve options documentation ( #1071 )
...
* Sort by name
* Document `hideSingleRequestSampleTab`
* End option description with `.`
2019-10-16 15:58:02 +03:00
Roman Hotsiy
9f0694c10f
docs: expandDefaultServerVariables
2019-09-30 12:56:09 +03:00
Quinn Blenkinsop
d74e2d6c46
docs: Add core-js as peer dependency in docs ( #1018 )
2019-08-20 10:12:27 +03:00
Roman Hotsiy
1504ade0e2
chore: add docs
2019-07-29 17:33:22 +03:00
Aleksandr Karo
d3f1c1677c
feat: add sampleCollapseLevel option ( #937 )
...
* feat: add sampleCollapseLevel option
* fix: rename sampleCollapseLevel option to jsonSampleExpandLevel
Change README.md description
* fix: provide maxCollapseLevel option via argument
* fix: rename normalizer function and some vars
2019-07-29 15:26:16 +03:00
David Beacham
0eb1e66a10
feat: add x-additionalPropertiesName ( #622 ) ( #944 )
...
* Add x-additionalPropertiesName (#622 )
Supply custom name to be displayed for property name of
`additionalProperties`.
* Include prettier output for Schema.ts
2019-06-18 11:41:48 +03:00
Roman Hotsiy
d78029a04e
chore: move repo to Redocly org
2019-06-04 15:47:22 +03:00
Sander van de Graaf
18590ccc60
docs: Fixed typo ( #921 )
...
[ci skip]
2019-05-22 09:37:42 +03:00
Roman Hotsiy
301ca225ff
docs: add note about IE11 support when using as React component
...
resolves #809
2019-05-13 00:07:43 +03:00
davchen51
649940bfe5
docs: add additional property to theme usage doc ( #876 )
2019-03-31 11:08:33 +03:00
Alex Scammon
30cbba3f6f
docs: Fix the demo specUrl ( #778 )
2019-01-10 10:03:41 +02:00
Sebastián Ramírez
ab943a8dd5
docs: Add FastAPI to real-life usages in README ( #756 )
2018-12-24 11:25:31 +02:00
Patrick Elam
4f60ec85aa
docs: fixed links to oas spec page ( #728 )
2018-11-30 10:09:40 +02:00
mknoszlig
4691d78dc0
docs: fix link to Dockerfile. ( #710 )
...
[ci skip]
2018-11-14 14:37:14 +02:00
Robert DeRose
5c9f488656
docs: corrected Docker Port in README.md ( #691 )
...
The command to launch ReDoc with Docker had the `-p` values reversed.
According to the Docker Docs, it should be `HOST_PORT:CLIENT_PORT`.
The Nginx service is running on port 80 inside the container, 8080 is the
port exposed on the host.
2018-11-05 16:44:44 +02:00
