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

updates museum.yaml with logo and replaces petstore with museum api in playground for local dev and some minor edits to redoc name

Browse Source
This commit is contained in:
Heather Cloward 2024-03-28 11:57:21 -04:00
parent 2776850597
commit 5324aa3674
6 changed files with 82 additions and 61 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

93
demo/index.html
View File

@ -1,46 +1,63 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head>
<meta charset="UTF-8" />
<title>Redoc Interactive Demo</title>
<meta
name="description"
content="Redoc Interactive Demo. OpenAPI-generated API Reference Documentation"
/>
<meta name="viewport" content="width=device-width, initial-scale=1" />
<head> <meta property="og:title" content="Redoc Interactive Demo" />
<meta charset="UTF-8" /> <meta
<title>ReDoc Interactive Demo</title> property="og:description"
<meta name="description" content="ReDoc Interactive Demo. OpenAPI/Swagger-generated API Reference Documentation" /> content="Redoc Interactive Demo. OpenAPI-generated API Reference Documentation"
<meta name="viewport" content="width=device-width, initial-scale=1"> />
<meta
property="og:image"
content="https://user-images.githubusercontent.com/3975738/37729752-8a9ea38a-2d46-11e8-8438-42ed26bf1751.png"
/>
<meta name="twitter:card" content="summary_large_image" />
<meta property="og:title" content="ReDoc Interactive Demo"> <style>
<meta property="og:description" content="ReDoc Interactive Demo. OpenAPI/Swagger-generated API Reference Documentation"> body {
<meta property="og:image" content="https://user-images.githubusercontent.com/3975738/37729752-8a9ea38a-2d46-11e8-8438-42ed26bf1751.png"> margin: 0;
<meta name="twitter:card" content="summary_large_image"> padding: 0;
}
<style> redoc {
body { display: block;
margin: 0; }
padding: 0; </style>
} <link
href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
rel="stylesheet"
/>
</head>
redoc { <body>
display: block; <div id="container"></div>
}
</style>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body> <script>
<div id="container"> </div> (function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r;
(i[r] =
i[r] ||
function () {
(i[r].q = i[r].q || []).push(arguments);
}),
(i[r].l = 1 * new Date());
(a = s.createElement(o)), (m = s.getElementsByTagName(o)[0]);
a.async = 1;
a.src = g;
m.parentNode.insertBefore(a, m);
})(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga');
<script> if (window.location.host === 'rebilly.github.io') {
(function (i, s, o, g, r, a, m) { ga('create', 'UA-81703547-1', 'auto');
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () { ga('send', 'pageview');
(i[r].q = i[r].q || []).push(arguments) }
}, i[r].l = 1 * new Date(); a = s.createElement(o), </script>
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m) </body>
})(window, document, 'script', 'https://www.google-analytics.com/analytics.js', 'ga'); </html>
if (window.location.host === 'rebilly.github.io') {
ga('create', 'UA-81703547-1', 'auto');
ga('send', 'pageview');
}
</script>
</body>
</html>

BIN
demo/museum-logo.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 2.5 KiB

3
demo/museum.yaml
View File

@ -6,6 +6,9 @@ info:
contact: contact:
email: team@redocly.com email: team@redocly.com
url: 'https://redocly.com/docs/cli/' url: 'https://redocly.com/docs/cli/'
x-logo:
url: 'https://redocly.github.io/redoc/museum-logo.png'
altText: Museum logo
license: license:
name: MIT name: MIT
url: 'https://opensource.org/license/mit/ ' url: 'https://opensource.org/license/mit/ '

2
demo/playground/hmr-playground.tsx
View File

@ -9,7 +9,7 @@ const swagger = window.location.search.indexOf('swagger') > -1;
const userUrl = window.location.search.match(/url=(.*)$/); const userUrl = window.location.search.match(/url=(.*)$/);
const specUrl = const specUrl =
(userUrl && userUrl[1]) || (swagger ? 'swagger.yaml' : big ? 'big-openapi.json' : 'openapi.yaml'); (userUrl && userUrl[1]) || (swagger ? 'museum.yaml' : big ? 'big-openapi.json' : 'museum.yaml');
const options: RedocRawOptions = { nativeScrollbars: false, maxDisplayedEnumValues: 3 }; const options: RedocRawOptions = { nativeScrollbars: false, maxDisplayedEnumValues: 3 };

43
demo/playground/index.html
View File

@ -1,25 +1,26 @@
<!DOCTYPE html> <!DOCTYPE html>
<html> <html>
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>Redoc</title>
<style>
body {
margin: 0;
padding: 0;
}
<head> redoc {
<meta charset="UTF-8" /> display: block;
<meta name="viewport" content="width=device-width, initial-scale=1"> }
<title>ReDoc</title> </style>
<style> <link
body { href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
margin: 0; rel="stylesheet"
padding: 0; />
} </head>
redoc { <body>
display: block; <redoc id="example"></redoc>
} </body>
</style> </html>
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
</head>
<body>
<redoc id="example"></redoc>
</body>
</html>

2
demo/webpack.config.ts
View File

@ -121,7 +121,7 @@ export default (env: { playground?: boolean; bench?: boolean } = {}, { mode }) =
webpackIgnore(/json-schema-ref-parser\/lib\/dereference\.js/), webpackIgnore(/json-schema-ref-parser\/lib\/dereference\.js/),
webpackIgnore(/^\.\/SearchWorker\.worker$/), webpackIgnore(/^\.\/SearchWorker\.worker$/),
new CopyWebpackPlugin({ new CopyWebpackPlugin({
patterns: ['demo/openapi.yaml'], patterns: ['demo/museum.yaml'],
}), }),
], ],
}); });