docs(adoc): purpose of the plugin

This commit is contained in:
@ 2024-11-14 22:59:08 +01:00
commit aa55e892e0

19
plugins/adoc/README.md Normal file
View file

@ -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
```