@@ -9,9 +9,9 @@ The purpose of this repository is to show a template **to document a project wit
### Deploy on localhost
1. Clone this repository `git clone https://lab.gsi.upm.es/docs/mkdocs-material` and detele git dependencies with `rm -rf .git` or create a new mkdocs project with `mkdocs new <name-project>` with the same structure and copy the folder `latex-templates` and the files `pdf_metadata.md` and `mkdocs.yml`.
2. Serve the docs running in Docker with the image [jtr0/mkdocs-material](https://hub.docker.com/r/jtr0/mkdocs-material) or [registry.gsi.upm.es/docs/mkdocs-material](https://lab.gsi.upm.es/docs/mkdocs-material/container_registry/)(recommended because it has installed [mkdocs-pandoc-plugin](https://pypi.org/project/mkdocs-pandoc-plugin/) and [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin)). Other option is to use the oficial image [squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material/) but without pdf generator and it's neccesary to comment `pandoc` and `git-revision-date-localized` options in [mkdocs.yml](config/en/mkdocs.yml). Using an image with plugins:
2. Serve the docs running in Docker with the image [jtr0/mkdocs-material](https://hub.docker.com/r/jtr0/mkdocs-material) or [registry.gsi.upm.es/docs/mkdocs-material](https://lab.gsi.upm.es/docs/mkdocs-material/container_registry/)(recommended because it has installed [mkdocs-pandoc-plugin](https://pypi.org/project/mkdocs-pandoc-plugin/) and [mkdocs-git-revision-date-localized-plugin](https://github.com/timvink/mkdocs-git-revision-date-localized-plugin)). Other option is to use the oficial image [squidfunk/mkdocs-material](https://hub.docker.com/r/squidfunk/mkdocs-material/) but without pdf generator and it's neccesary to comment `pandoc` and `git-revision-date-localized` options in [mkdocs.yml](../../config/en/mkdocs.yml). Serve docs using an image with plugins:
```bash
docker run --rm-it-p 8000:8000 -v${PWD}:/docs registry.gsi.upm.es/docs/mkdocs-material
docker run --rm-it-p 8000:8000 -v${PWD}:/docs registry.gsi.upm.es/docs/mkdocs-material serve -f config/en/mkdocs.yml
```
3. Open [http://localhost:8000/](http://localhost:8000/) in your browser.
1. Go to GitLab, select `Set CI/CD` and copy the content of [`.gitlab-ci.yml`](../../.gitlab-ci.yml).
1. Go to GitLab, select `Set CI/CD` and copy the content of [`.gitlab-ci.yml`](https://lab.gsi.upm.es/docs/mkdocs-material/-/blob/main/.gitlab-ci.yml).