Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-21 16:16:33 +03:00
Code Issues Packages Projects Releases Wiki Activity
2,599 Commits 13 Branches 225 Tags 86 MiB
main
Commit Graph

82 Commits

Author SHA1 Message Date
Taylor Krusen
11912f5d91
docs(all): change admonition type to 'info' (#2608) 2024-10-18 07:47:56 -07:00
Alex Varchuk
64f18779e5
feat: add support x-badges (#2605) 
* feat: add support x-badges

Co-authored-by: Max Mueller <maxmueller@eaton.com>

* chore: try to fix e2e tests

* chore: try to fix e2e tests part 2

* Update docs/redoc-vendor-extensions.md

---------

Co-authored-by: Max Mueller <maxmueller@eaton.com>
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
 2024-10-16 11:48:21 +03:00
Lorna Jane Mitchell
c04b4c8fec
docs: Remove the old zero-dependency claim for Redoc docs (#2590) 2024-09-16 09:12:25 +01:00
Lorna Jane Mitchell
c813eeac04
docs: fix http-server example from in-page feedback (#2580) 2024-09-02 11:48:55 +01:00
Alex Varchuk
a7607eafdd
docs: update broken link of Openapi Object (#2577) 2024-08-29 19:18:05 +02:00
Lorna Jane Mitchell
8c391497bf
docs: Fix a link that couldn't be checked as it reaches outside the Redoc project (#2490) 2024-02-12 14:44:00 +00:00
Lorna Jane Mitchell
4fd22f6d74
docs: Add docs tooling to align with publishing to main site (#2484) 
* docs: add markdownlint and some link checks alongside vale

* docs: add link checker config and fix/update some links reported broken

* docs: update markdownlint action

* docs: fix markdown table formatting

* docs: Unpin Vale version and pick up the latest
 2024-01-29 16:39:44 +00:00
Adam Altman
8c04c02ab0
docs: fix admonition on config page (#2452) 2023-11-13 10:16:32 +00:00
redocly-bot
7b2931dc91 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-11-09 15:56:30 +00:00
redocly-bot
ba7cd0a130 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-10-23 12:07:23 +00:00
redocly-bot
f28a807dec sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-10-18 14:49:43 +00:00
redocly-bot
25394b7aba sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-10-09 19:12:25 +00:00
redocly-bot
75065a28fd sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-10-09 16:35:52 +00:00
redocly-bot
ff492b5eb2 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-09-28 11:43:40 +00:00
redocly-bot
aadc32c1eb sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-09-21 14:20:06 +00:00
Lorna Jane Mitchell
b3503f2109
Config docs and README refresh (#2393) 
* docs: Give Redoc a landing page with overview and tldr instructions

* docs: move config to dedicated page

* docs: modernise README, link to resources

* docs: more detailed format for theme configurations

* fix: README formatting

* fix: Fix future tense errors and add exceptions for config fields as headings

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

* docs: minor updates from excellent pull request feedback

* docs: Remove the old quickstart, update HTML as the preferred onboarding method and improve docs/examples on that page

* Apply suggestions from code review

Co-authored-by: Heather Cloward <heathercloward@gmail.com>

---------

Co-authored-by: Heather Cloward <heathercloward@gmail.com>
 2023-09-21 15:19:27 +01:00
Adam Altman
9b73dae685
docs: fix and update links in redoc-vendor-extensions (#2368) 
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
 2023-07-21 11:40:20 -05:00
Heather Cloward
c407726a66
docs: adds vale rules and workflow for running in CI (#2348) 
* docs: adds vale rules and workflow for running in CI

* docs: updates product name from ReDoc to Redoc
 2023-07-11 13:31:52 -04:00
redocly-bot
44372d5702 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-06-13 17:13:40 +00:00
Heather Cloward
7e4639e8cf
docs: updates the redocly cli command prefix from openapi to redocly in the redoc deployment guide intro page (#2326) 2023-05-26 11:11:14 -04:00
redocly-bot
6a2f2c98e0 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-05-10 18:51:48 +00:00
redocly-bot
c26e3473a4 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-03-31 17:40:37 +00:00
Alex Varchuk
64cf624fff
chore: rename master branch to main (#2163) 2022-09-12 19:28:47 +03:00
Maria McParland
17bb08909a
Fixing 404 on the documentation page (#2092) 2022-07-25 17:34:40 +03:00
redocly-bot
01ffff7f15 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-06-20 07:05:04 +00:00
Alex Varchuk
77104d6c0d
feat: add Redoc to Redocly CDN (#2026) 2022-05-30 13:40:19 +03:00
redocly-bot
0aafee1131 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-05-18 09:06:41 +00:00
redocly-bot
7988e8137c sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-05-10 21:43:23 +00:00
redocly-bot
20e4316535 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-05-06 16:38:07 +00:00
redocly-bot
0c23f8d051 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-03-21 14:48:22 +00:00
redocly-bot
a36610b3c5 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-03-21 14:25:04 +00:00
AlexVarchuk
30b3b57b26
chore: update docs about support IE 11 (#1938) 2022-03-21 15:51:23 +02:00
redocly-bot
cb3d0a018e sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-03-14 10:21:58 +00:00
redocly-bot
ab02f667a1 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-02-09 12:18:16 +00:00
Oprysk Vyacheslav
b604bd8da8
fix: exclusiveMin/Max shows incorect range (#1799) 
* fix: exclusiveMin/Max shows incorect range

* cover all number range cases & add unit tests

* add more tests

* fix maximum value

* simplify humanizeNumberRange function

* simplify exclusive checks

* Update src/utils/openapi.ts

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>

* update test coverage

* linting

* revert weird prettier changes

* add md files to prettier ignore

Co-authored-by: Roman Hotsiy <gotsijroman@gmail.com>
 2021-11-24 16:47:24 +02:00
redocly-bot
82df17d871 sync: Synced local 'docs/' with remote 'docs/redoc/' 2021-11-23 17:46:45 +00:00
redocly-bot
7e287d984e sync: Synced local 'docs/' with remote 'docs/redoc/' 2021-11-23 14:47:32 +00:00
redocly-bot
bf6b85d4ba sync: Synced local 'docs/' with remote 'docs/redoc/' 2021-11-23 05:08:42 +00:00
Heather Cloward
6cbd96a24a
[GSoD]Reorganizes the quickstart into a deployment guide and quickstart (#1749) 
* Reorganizes the quickstart into a deployment guide and quickstart

* Minor edits

* fix: minor formatting issue

* fix: simplify phrasing

* Adds redirects, link to preview-docs docs, and other review edits

* remove IE polyfills as IE is no longer supported

Co-authored-by: Ivana Isadora Devcic <33730345+skadinna@users.noreply.github.com>
 2021-11-23 16:07:56 +11:00
Heather Cloward
669adddc9d Updates per reviews and adds new logo 2021-09-22 22:17:19 -04:00
Adam Altman
683eabbbf0
docs: fix broken links in intro (#1730) 2021-08-24 21:40:16 -05:00
Heather Cloward
e8412e8e93
docs(GSOD): Adds new quickstart doc (#1718) 2021-08-24 20:44:27 -05:00
Swapnil Ogale
0c782ec51f
docs: improvements to vendor extensions topic (#1386) 2020-10-13 14:55:45 +03:00
JoBrad
b6414f4e43
Updated x-servers link to point to valid location. (#1267) 2020-05-24 23:06:08 +03:00
Roman Hotsiy
becc2f5856
fix: depreacate x-code-samples, rename to x-codeSamples for consistency 2020-05-10 22:11:01 +03:00
Mohamed Zenadi
ea5b0aabf9
feat: add x-explicitMappingOnly extension (#1215) 2020-03-27 12:09:44 +02: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
Roman Hotsiy
301ca225ff
docs: add note about IE11 support when using as React component 
resolves #809
 2019-05-13 00:07:43 +03:00
Sergio Regueira
3659a75020 chore: Group documentation of x-traitTag extension (#802) 2019-02-26 08:58:18 +01:00