From 40665766b00a6451fba2a1a99078e0615e778d1b Mon Sep 17 00:00:00 2001 From: Mr-Leshiy Date: Fri, 17 Nov 2023 15:31:38 +0200 Subject: [PATCH] update guide --- docs/src/guides/docs.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/src/guides/docs.md b/docs/src/guides/docs.md index a6982a6f6..7c0054890 100644 --- a/docs/src/guides/docs.md +++ b/docs/src/guides/docs.md @@ -47,13 +47,16 @@ src: DO ../earthly/docs+SRC # Now copy into that any artifacts we pull from the builds. - COPY --dir ../+repo-docs/repo /docs/includes + COPY --dir ../+repo-docs/repo includes ``` The first step of building process it preparing a source files. It is mandatory to have a `src` directory with all documentation md files in it and `mkdocs.yml` file. -This directory and file will be picked up as a part of the `+SRC` UDC target. -Also it is possible to provide some additional files which should be added to the `/docs/includes` dir. +This directory and file will be picked during the execution of `+SRC` UDC target. +Also it is possible to replace defined `includes`, `macros` and `overrides` dirs +to customize some docs appearance and configuration. +Default value of the content of `includes`, `macros` and `overrides` dirs you can find in `earthly/docs` folder. +Additionally it is possible to provide some additional files as for example to extend `includes` dir content. ```Earthfile # Build the docs here.