-
Notifications
You must be signed in to change notification settings - Fork 170
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(fix, docs): document frames and endpoint req/res snippets (#3490)
* (fix, docs): document frames and endpoint req/res snippets * add icons
- Loading branch information
Showing
14 changed files
with
78 additions
and
791 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: Endpoint Request Snippet | ||
excerpt: Reference an endpoint request from your API Reference | ||
--- | ||
|
||
The `EndpointRequestSnippet` component is used to reference an endpoint | ||
request from your API Reference. Below is an example of referencing the | ||
request for the `POST /snippets` endpoint. | ||
|
||
<EndpointRequestSnippet endpoint='POST /snippets' /> | ||
|
||
<Aside> | ||
|
||
<CodeBlock title="Markdown"> | ||
```jsx | ||
<EndpointRequestSnippet endpoint='POST /snippets' /> | ||
``` | ||
</CodeBlock> | ||
|
||
</Aside> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: Endpoint Response Snippet | ||
excerpt: Reference an endpoint response from your API Reference | ||
--- | ||
|
||
The `EndpointResponseSnippet` component is used to reference an endpoint | ||
request from your API Reference. Below is an example of referencing the | ||
response for the `POST /snippets` endpoint. | ||
|
||
<EndpointResponseSnippet endpoint='POST /snippets' /> | ||
|
||
<Aside> | ||
|
||
<CodeBlock title="Markdown"> | ||
```jsx | ||
<EndpointResponseSnippet endpoint='POST /snippets' /> | ||
``` | ||
</CodeBlock> | ||
|
||
</Aside> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
--- | ||
title: 'Frames' | ||
excerpt: 'Wrap images in a container with the frame component' | ||
--- | ||
|
||
<Frame caption="Beautiful mountains"> | ||
<img src="https://images.pexels.com/photos/1867601/pexels-photo-1867601.jpeg" /> | ||
</Frame> | ||
|
||
<Aside> | ||
|
||
<CodeBlocks> | ||
```jsx title="Markdown" | ||
<Frame caption="Beautiful mountains"> | ||
// Or a relative path to an image in the project | ||
<img src="https://images.pexels.com/photos/1867601.jpeg" /> | ||
</Frame> | ||
``` | ||
</CodeBlocks> | ||
|
||
</Aside> |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.