diff --git a/docs/docs/en/usecase/index.md b/docs/docs/en/usecase/index.md index 8319352..20a50b7 100644 --- a/docs/docs/en/usecase/index.md +++ b/docs/docs/en/usecase/index.md @@ -1,4 +1,4 @@ -# Usecase +# Usecases A collection of use cases for this plugin. **If you have a one, please share it with us.** diff --git a/docs/docs/index.md b/docs/docs/index.md index 36ebee7..2c3771f 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -1,9 +1,31 @@ -# 🚀 APIRequest +# 🔎 Overview -[![Obsidian plugin release](https://img.shields.io/badge/Obsidian%20plugin%20release-purple?logo=obsidian&style=flat-square)](https://obsidian.md/plugins?id=api-request) -[![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/rooyca/obsidian-api-request?logo=github&color=ee8449&style=flat-square)](https://github.com/rooyca/obsidian-api-request/releases/latest) -GitHub Release +APIRequest (APIR) is a plugin for the note taking app [Obsidian](https://obsidian.md/) that allows you to make requests to apis display the response in your notes. -> [![Español](https://img.shields.io/badge/Español-8A2BE2)](es/index.md) -> [![English](https://img.shields.io/badge/English-8A2BE2)](en/index.md) -> [![中文](https://img.shields.io/badge/中文-8A2BE2)](zh/index.md) \ No newline at end of file +## 🔥 Features + +- Perform requests using various methods such as `GET`, `POST`, `PUT`, and `DELETE`. +- Use variables from the `front-matter`, global variables or even reuse responses from another codeblocks. +- Save responses in the `localStorage` for convenient access and reuse. +- Disable code blocks as needed to optimize performance. +- Extract and display specific values from responses, giving you fine-grained control over how data is presented. + +## ⚡ How to use + +To make a request, create a code-block with the language set to `req`. Inside the code-block, you can define parameters such as `url`, `method`, `body`, `headers`, etc. See the [available flags](en/codeblocks#flags) for a complete reference. + +~~~markdown +```req +url: https://my-json-server.typicode.com/typicode/demo/comments +method: post +body: {"id":1} +headers: {"Accept": "application/json"} +show: $.id +req-uuid: IDpersona +disabled +``` +~~~ + +## 🧩 Use Cases + +Check out the [Use Cases](en/usecase) section for examples of how you can use APIRequest in your workflows. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 5bfb61c..4eea431 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -23,15 +23,13 @@ theme: nav: - English: - - Overview: en/index.md - - Usage: - - codeblocks: en/codeblocks.md - - usecase: en/usecase + - Usage: en/codeblocks.md + - Use Cases: en/usecase - Español: - Inicio: es/index.md - Uso: - - bloques de código: es/codeblocks.md - - ejemplos de uso: es/usecase + - Cómo usar: es/codeblocks.md + - Casos de uso: es/usecase - 中文: - 概述: zh/index.md - 用法: diff --git a/manifest.json b/manifest.json index 288ea0f..1a226ed 100644 --- a/manifest.json +++ b/manifest.json @@ -1,7 +1,7 @@ { "id": "api-request", "name": "APIRequest", - "version": "2.0.5", + "version": "2.0.6", "minAppVersion": "0.15.0", "description": "Fetch data from APIs or other sources. Responses in JSON, MD or HTML directly in your notes.", "author": "rooyca", diff --git a/package-lock.json b/package-lock.json index 8396fdb..da93937 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "api-request", - "version": "2.0.5", + "version": "2.0.6", "lockfileVersion": 3, "requires": true, "packages": { diff --git a/package.json b/package.json index cb632e4..37d2d51 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "api-request", - "version": "2.0.5", + "version": "2.0.6", "description": "Fetch data from APIs or other sources. Responses in JSON, MD or HTML directly in your notes.", "main": "main.js", "scripts": {