diff --git a/docs/docker/cypress/index.md b/docs/docker/cypress/index.md index 23d19273639ca0a3ec79d7c352f4be9f0c53ff18..9f410aa3d34ab599047b696186fd65bfa17db2b8 100644 --- a/docs/docker/cypress/index.md +++ b/docs/docker/cypress/index.md @@ -40,4 +40,4 @@ to the Docker container: - CYPRESS_basicauth_user={{ your.user }} - CYPRESS_basicauth_pass={{ your.pass }} -Now the `visit` function takes care for it automatically. \ No newline at end of file +Now the `visit` and all `login` functions take care for it automatically. diff --git a/docs/docker/mdshow/index.md b/docs/docker/mdshow/index.md new file mode 100644 index 0000000000000000000000000000000000000000..49adca7267a24cf794020bdf2870a4e173889749 --- /dev/null +++ b/docs/docker/mdshow/index.md @@ -0,0 +1,21 @@ +--- +title: Docker mdshow +repo: https://gitlab.lakedrops.com/docker/mdshow +issues: https://gitlab.lakedrops.com/docker/mdshow/-/issues +tags: +- docker +- mdshow +- tests +--- +# mdshow + +This docker projects provides a useful tool to create HTML presentations and PDFs using markdown. + +To get more Information see [here](https://github.com/jceb/mdshow). +We recommend to use [Ahoy](composer/plugin/ahoy/) by creating an `.ahoy.yml` file, +like [this](https://gitlab.lakedrops.com/lakedrops/slides/-/blob/main/.ahoy.yml?ref_type=heads). This offers three +command: + +- serve +- html +- update diff --git a/docs/docker/mkdocs/index.md b/docs/docker/mkdocs/index.md new file mode 100644 index 0000000000000000000000000000000000000000..ab1a708ecbb9676737e1a516cf1a5245046a7464 --- /dev/null +++ b/docs/docker/mkdocs/index.md @@ -0,0 +1,42 @@ +--- +title: Docker MkDocs +repo: https://gitlab.lakedrops.com/docker/mkdocs +issues: https://gitlab.lakedrops.com/docker/mkdocs/-/issues +tags: +- docker +- mkdocs +- tests +--- +# MkDocs + +This project provides a tool for creating HTML documentation with markup. We used it for this documentation website +for obvious reasons. Like in many other projects we recommend using [Ahoy](composer/plugin/ahoy/). The file could look like: + + +```mkdocs +ahoyapi: v2 +commands: + up: + cmd: | + docker-compose up -d + echo "Open site in browser: http://127.0.0.1:8999" + echo "It may take a few seconds before the server is up and running." + usage: Start MkDocs server. + down: + cmd: docker-compose down + usage: Stop MkDocs server and remove container. + stop: + cmd: docker-compose stop + usage: Stop MkDocs server. + restart: + cmd: docker-compose restart + usage: Restart MkDocs server. + logs: + cmd: docker-compose logs -f + usage: Show logs from MkDocs server. + build: + cmd: docker-compose exec --workdir=/mkdocs mkdocs mkdocs build + usage: Builds the documentation in site directory. +``` + +See more information [here](https://www.mkdocs.org/). \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index ca5dff24119bc2f5e1186b2eb75c917f2e5b117c..f1c0a58cdc957f1e5ff562c11c7fbfde25b1d5da 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -97,6 +97,10 @@ nav: - docker/l3d/index.md - Drupal: docker/l3d/drupal.md - Changelog: docker/l3d/changelog.md + - mdshow: + - docker/mdshow/index.md + - MkDocs: + - docker/mkdocs/index.md - Maven: - docker/maven-build/index.md - Node: