forked from stoplightio/elements
-
Notifications
You must be signed in to change notification settings - Fork 4
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: updating the preview documentation
- Loading branch information
1 parent
3701384
commit 30ab51b
Showing
3 changed files
with
182 additions
and
50 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,14 +1,26 @@ | ||
# Elemental Preview | ||
|
||
Elemental Preview is a Visual Studio Code extension that helps you write, and maintain your OpenAPI documents. | ||
The extension allows you to preview your OpenAPI document in jpmorganchase elemental directly from your IDE. | ||
|
||
## Installation | ||
|
||
This folder contains a vscode extension for viewing Elemental directly from your IDE. | ||
This allows API developers to see how their spec will display without having to run the demo project or deploy it. | ||
To install the extension in VS Code: | ||
|
||
** Currently this extension is only available from the code here. We are in the process of publishing it ** | ||
1. Press [Ctrl+Shift+X] or [⇧⌘X] to open the _Extensions_ tab. | ||
|
||
## How to run | ||
2. Type `Elemental Preview` to search for the extension in Marketplace. | ||
|
||
1. Open `src/extension.ts' file | ||
2. Press F5 button | ||
3. Run the 'Elemental: Preview' command from the Command Palette (⇧⌘P) in the new window: | ||
3. Find the extension in the list and select **Install**. | ||
|
||
4. When the installation is complete, select **Enable** to activate the extension in your workspace. | ||
|
||
5. Open your OpenAPI document. | ||
|
||
6. Press [Ctrl+Shift+P] or [⇧⌘P] to open the _Commands_ tab. | ||
|
||
7. Type `Elemental: Preview UI` to search for the command. | ||
|
||
## Current Limitations | ||
|
||
- Unbundled OpenAPI documents aren't supported |
Oops, something went wrong.