From 6a161e1b9f99b71a1cd94aa91dc384f3e245d212 Mon Sep 17 00:00:00 2001 From: Daniel Speicher <daniel.speicher@lakedrops.com> Date: Thu, 13 Jun 2024 17:22:41 +0200 Subject: [PATCH] Add Cypress to docker/l3d#85 --- docs/docker/cypress/index.md | 2 +- docs/docker/mdshow/index.md | 21 ++++++++++++++++++ docs/docker/mkdocs/index.md | 42 ++++++++++++++++++++++++++++++++++++ mkdocs.yml | 4 ++++ 4 files changed, 68 insertions(+), 1 deletion(-) create mode 100644 docs/docker/mdshow/index.md create mode 100644 docs/docker/mkdocs/index.md diff --git a/docs/docker/cypress/index.md b/docs/docker/cypress/index.md index 23d1927..9f410aa 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 0000000..49adca7 --- /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 0000000..ab1a708 --- /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 ca5dff2..f1c0a58 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: -- GitLab