Skip to content

Commit

Permalink
index index headline and integration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
wouterkroes committed Jul 12, 2021
1 parent 0aaae48 commit f7fb48d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
3 changes: 1 addition & 2 deletions docs/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ const Home = () => {
<span>with appropriate type-signatures</span>
</h1>
<p className="mt-3 text-base text-gray-700 sm:mt-5 sm:text-xl lg:text-lg xl:text-xl">
Generate, valid, cache and mock in your React and Angular
applications all with your OpenAPI specification.
Generate, valid, cache and mock in your frontend applications all with your OpenAPI specification.
</p>

<div className="mt-5 mx-auto sm:flex sm:justify-center lg:justify-start lg:mx-0 md:mt-8">
Expand Down
11 changes: 8 additions & 3 deletions docs/src/pages/reference/integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,19 @@ id: integration
title: Integration
---

Give you the possibility to use Orval with a script.
### Import script

Orval expose a function which takes a path to the Orval config as an argument.
Orval gives you the possibility to import Orval.

It expose a function which takes a path to the Orval config as the argument.

```js
import orval from 'orval';

orval('./orval.config.js');
```

It's use for the <a href="https://marketplace.visualstudio.com/items?itemName=orval.orval-vscode" target="_blank">vscode Orval extension</a>.

### VS Code extension

The Visual Studio Code <a href="https://marketplace.visualstudio.com/items?itemName=orval.orval-vscode" target="_blank">Orval</a> extension will look for the Orval config file in your opened workspace and run Orval.

0 comments on commit f7fb48d

Please sign in to comment.