diff --git a/README.md b/README.md index 6f0d4c9..2800fc9 100644 --- a/README.md +++ b/README.md @@ -17,7 +17,7 @@ This command generates the documentation and deploys it on your CodeDoc space - `-b --branch [branch]` pattern of branch names to deploy - `-l --loc [dir]` location of the documentation sources root - **required** -- `-t --type [docusaurus|doxygen|swagger]` type of documentation generator to use. - **required** +- `-t --type [docusaurus|doxygen|mdbook|swagger]` type of documentation generator to use. - **required** - `-d --dest [dir]` path to where to put the documentation outputs in your repository's CodeDoc space - **optional !! cannot be absolute !!** Note ! @@ -29,6 +29,7 @@ Usage examples : /entrypoint.sh -l ./documentation/api/api-swagger.yml -t swagger -d api_documentation /entrypoint.sh -l ./documentation/app -t docusaurus -d application_documentation /entrypoint.sh -b main -l ./src/Doxyfile -t doxygen -d sourcecode_documentation +/entrypoint.sh -l ./doc -t mdbook -d book ``` ### How to add a custom documentation generator ? diff --git a/entrypoint.sh b/entrypoint.sh index 4c9ee61..73af274 100755 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -9,8 +9,8 @@ help() { cat <