Skip to content

Commit

Permalink
update release build
Browse files Browse the repository at this point in the history
  • Loading branch information
Melissa Garcia committed Mar 13, 2024
1 parent a5e783b commit dae4bc5
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
73 changes: 73 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,13 @@ Using a theme, all of your default configuration lives in an npm package.
- [Metadata with Front matter](#metadata-with-front-matter)
- [OpenAPI](#openapi)
- [Redocly API Block](#RedoclyAPIBlock)
- [On-premise license keys](#on-premise-license-keys)
- [Full width page](#full-width-page)
- [width (optional)](#width-optional)
- [typography (optional)](#typography-optional)
- [codeblock (optional)](#codeblock-optional)
- [disableSidebar (optional)](#disablesidebar-optional)
- [disableSearch (optional)](#disablesearch-optional)
- [JSDoc](#jsdoc)
- [MDX](#mdx)
- [Modular Content System](#modular-content-system)
Expand Down Expand Up @@ -1081,14 +1088,80 @@ We use [Redoc](https://github.com/Redocly/redoc) to render OpenAPI specs. Simply
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." />
```
We can now host your own OpenAPI YAML files and have them rendered by Redocly documents. This approach allows us to avoid using iframes and instead host our own API YAML files directly in Redocly.
#### On-premise license keys
When implementing this feature, ensure that GATSBY_REDOCLY_KEY: ${{ secrets.REDOCLY_LICENSE_KEY }} is added to the deploy.yml file in the repository. Additionally, for new repositories, remember to include the on-premise license keys through the repository settings.
The license key should be found in your redocly account settings -> On-premise license keys
![redocly-setting](docs/images/redocly-setting.png)
#### Full width page
Use [custom layout](#custom-layout) to do a full width page
#### width (optional)
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." width="600px" />
```
Sets the width (of the right panel).
Defaults to ```'500px'```
https://redocly.com/docs/api-reference-docs/configuration/theming/#path=rightPanel
#### typography (optional)
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." typography="fontFamily: `serif`, fontSize: '16px'" />
```
Controls the appearance of text.
Defaults to ```'fontFamily: `adobe-clean, "Source Sans Pro", -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Ubuntu, "Trebuchet MS", "Lucida Grande", sans-serif`'```
https://redocly.com/docs/api-reference-docs/configuration/theming/#path=typography
#### codeblock (optional)
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." codeBlock="tokens: { punctuation: { color: 'red ' }}" />
```
Controls the appearance of code snippets.
Defaults to ```"tokens: { punctuation: { color: 'white' }}"```
https://redocly.com/docs/api-reference-docs/configuration/theming/#path=codeBlock
#### disableSidebar (optional)
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." disableSidebar />
```
If set to `true`, hides the navigation sidebar (the left panel). Setting this option to `false` does not disable the search feature.
Defaults to ```false```
https://redocly.com/docs/api-reference-docs/configuration/functionality/#theme-object-openapi-schema
#### disableSearch (optional)
```js
<RedoclyAPIBlock src="URL pointing to your open api yaml file." disableSearch />
```
Disables search indexing and hides the search box from the API documentation page.
Defaults to ```false```
https://redocly.com/docs/api-reference-docs/configuration/functionality/#theme-object-openapi-schema
### JSDoc
We currently recommend to use the [JSDoc to markdown](https://github.com/jsdoc2md/jsdoc-to-markdown) converter.
Expand Down
12 changes: 12 additions & 0 deletions packages/gatsby-theme-aio/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,18 @@
All notable changes to this project will be documented in this file.
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.

## [4.11.7](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.11.4...@adobe/gatsby-theme-aio@4.11.7) (2024-03-13)

### Features

* **DEVSITE-1106:** Make width and codeblock customizable [8a76182](https://github.com/adobe/aio-theme/commit/8a76182c4f259331975e478d320a19d01a21bf3c)
* **DEVSITE-1106:** Make disableSidebar and disableSearch customizable [486625c](https://github.com/adobe/aio-theme/commit/486625c98452b8a5f657840e366a701069e41e0d)
* **DEVSITE-1106:** Make typography customizable [a5e783b](https://github.com/adobe/aio-theme/commit/a5e783bfd5e516de4eb2e2d6d7f26135a8a0e7c3)

### Fix

* **DEVSITE-1106:** Hide loading animation as a work-around to make the redocly integration appear more seamless [c3396c3](https://github.com/adobe/aio-theme/commit/c3396c308ff4a2623500aceba744eec47cef374c)

## [4.11.4](https://github.com/adobe/aio-theme/compare/@adobe/gatsby-theme-aio@4.11.3...@adobe/gatsby-theme-aio@4.11.4) (2023-02-28)

### Fix
Expand Down
2 changes: 1 addition & 1 deletion packages/gatsby-theme-aio/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@adobe/gatsby-theme-aio",
"version": "4.11.7-rc4",
"version": "4.11.7",
"description": "The Adobe I/O theme for building markdown powered sites",
"main": "index.js",
"license": "Apache-2.0",
Expand Down

0 comments on commit dae4bc5

Please sign in to comment.