Skip to content

Commit

Permalink
chore(doc): auto generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Oct 31, 2023
1 parent 91e99ed commit d0cd7e9
Showing 1 changed file with 14 additions and 16 deletions.
30 changes: 14 additions & 16 deletions doc/hurl.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,12 @@ Table of Contents *hurl.nvim-table-of-contents*
- Features |hurl.nvim-features|
- Usage |hurl.nvim-usage|
- Env File Support: vars.env |hurl.nvim-env-file-support:-vars.env|
- Demo |hurl.nvim-demo|
- Default Key Mappings |hurl.nvim-default-key-mappings|
- Tips |hurl.nvim-tips|
- Credits |hurl.nvim-credits|
- Author |hurl.nvim-author|
- Show your support |hurl.nvim-show-your-support|
Welcome to hurl.nvim 👋Hurl.nvim is a Neovim plugin that brings the power of the Hurl command line tool into your editor. Designed to run HTTP requests from `.hurl` files, this plugin simplifies the API development process, making it both efficient and versatile.
Welcome to hurl.nvim 👋Hurl.nvim is a Neovim plugin designed to run HTTP requests directly from `.hurl` files. Elevate your API development workflow by executing and viewing responses without leaving your editor.
FEATURES *hurl.nvim-features*

- 🚀 Execute HTTP requests directly from `.hurl` files.
Expand Down Expand Up @@ -49,47 +48,48 @@ Add the following configuration to your Neovim setup:

ENV FILE SUPPORT: VARS.ENV *hurl.nvim-env-file-support:-vars.env*

hurl.nvim offers first-class support for environment files named vars.env.
These files can manage environment variables that your HTTP requests may rely
on.
`hurl.nvim` offers seamless integration with `vars.env` files to manage
environment variables for your HTTP requests.


FILE LOCATION ~

hurl.nvim looks for a `vars.env` file in the following directories by default:
The plugin looks for a `vars.env` file in the following directories:

- Current file’s directory
- Project root directory
- src/
- test/
- tests/
- server/
- src/tests/
- server/tests/


DEMO *hurl.nvim-demo*
This makes it convenient to specify environment-specific variables that your
HTTP requests may use. ## Demo

Check out the following demos to see `hurl.nvim` in action:


RUN A FILE ~

Click on the GIF below to view the full demo:
Run the entire file by pressing `<leader>A` or run 'HurlRunner' command.

<https://gyazo.com/e554e81788aad910848ff991c9369d7b>


RUN A SELECTION ~

Click on the GIF below to view the full demo:
Select a range of lines and press `<leader>h` to execute the request or run
'HurlRunner' command.

<https://gyazo.com/1a44dbbf165006fb5744c8f10883bb69>


RUN AT CURRENT LINE ~

Click on the GIF below to view the full demo:
Place your cursor on the line you want to run and press `<leader>a` or run
'HurlRunnerAt' command to execute the request. It need be one of the HTTP
methods listed: GET, POST, PUT, DELETE, PATCH.

<https://gyazo.com/20efd2cf3f73238bd57e79fc662208b1>

Expand All @@ -108,10 +108,8 @@ displays.

TIPS *hurl.nvim-tips*

You could enable debug mode with `debug = true` in your configuration to see
more information. All the logs will be printed in the `hurl.nvim.log` in Neovim
cache folder. For instance, in MacOS, the log file is located at
`~/.cache/nvim/hurl.nvim.log`.
Enable debug mode with `debug = true` for detailed logs. Logs are saved at
`~/.cache/nvim/hurl.nvim.log` on macOS.


CREDITS *hurl.nvim-credits*
Expand Down

0 comments on commit d0cd7e9

Please sign in to comment.