From aa55e892e074e59bbc8b35ca15191beb28f3c483 Mon Sep 17 00:00:00 2001
From: "@" <@>
Date: Thu, 14 Nov 2024 22:59:08 +0100
Subject: [PATCH] docs(adoc): purpose of the plugin

---
 plugins/adoc/README.md | 19 +++++++++++++++++++
 1 file changed, 19 insertions(+)
 create mode 100644 plugins/adoc/README.md

diff --git a/plugins/adoc/README.md b/plugins/adoc/README.md
new file mode 100644
index 000000000..7a801d726
--- /dev/null
+++ b/plugins/adoc/README.md
@@ -0,0 +1,19 @@
+# [Asciidoctor](https://asciidoctor.org/)
+
+Function to create an `index.html` from a `README.adoc` into a folder `docs`
+
+This plugin provides a function for [AsciiDoc](https://asciidoc.org/).
+
+To use it, add `adoc` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... adoc)
+```
+
+after run `adoc` function.
+
+```
+README.adoc
+docs
+└── index.html
+```