morten/http.md
1
0
Fork 0
mirror of https://github.com/morten-olsen/http.md.git synced 2026-02-08 00:46:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: improved docs

Browse Source
This commit is contained in:
Morten Olsen
2025-05-18 21:18:05 +02:00
parent ad342e5f10
commit 6ce6eeeedb
3 changed files with 27 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/README.md
View File

@@ -209,34 +209,18 @@ The requests from the embedded document are processed, and their `request` and `
Assume `_shared_requests.md` contains:
````markdown
```http id=sharedGetRequest
GET https://httpbin.org/get
```
````
::raw-md[./examples/_shared_requests.md]
Then, in `main.md`:
````markdown
# Main Document
::raw-md[./examples/with-template.md]
Let's include some shared requests:
<details>
<summary>Output</summary>
::md[./_shared_requests.md]
::raw-md[./examples/with-template.md]{render}
The shared GET request returned: {{responses.sharedGetRequest.status}}
Now, a request specific to this document:
```http
POST https://httpbin.org/post
Content-Type: application/json
{"dataFromMain": "someValue", "sharedUrl": "{{requests.sharedGetRequest.url}}"}
```
::response
````
</details>
When `main.md` is processed, `_shared_requests.md` will be embedded, its `sharedGetRequest` will be executed, and its data will be available for templating.