quirinecker/docki
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

elaborated on the usage

Browse Source
This commit is contained in:
quirinecker
2025-11-22 18:45:21 +01:00
parent 1995e5310d
commit 1bb50c09bf
2 changed files with 9 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

BIN
.github/assets/directory_structure.png vendored Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 181 KiB

11
README.md
View File

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