diff --git a/.github/assets/directory_structure.png b/.github/assets/directory_structure.png new file mode 100644 index 0000000..c7eeae5 Binary files /dev/null and b/.github/assets/directory_structure.png differ diff --git a/README.md b/README.md index 16df200..c25af6c 100644 --- a/README.md +++ b/README.md @@ -8,8 +8,15 @@ Docki is cli for converting asciidoctor files into html files. ## Usage +Docki must be run in a directory with the following structure + +![docki directory structure](.github/assets/directory_structure.png) + +1. Will be converted into asciidoc format +2. Will be converted into asciidocs slides + > [!NOTE] -> This works in a directory with a directory called `docs`, which contains the asciidoctor documentation. +> The input directory can be defined either with a cli argument or the config file. Default is `./docs` ### Building the documentation @@ -17,7 +24,7 @@ Docki is cli for converting asciidoctor files into html files. docki build ``` -### Serving the documentation on a live server +### Serving the documentation with a live server ```shell docki serve