From 45ccfedf04b4517bec27abc42c97bd39486f3bbe Mon Sep 17 00:00:00 2001 From: Sina Atalay Date: Fri, 19 Jul 2024 17:47:18 +0300 Subject: [PATCH] docs: improve the user guide on using custom themes (#127) --- docs/user_guide/index.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md index 51e7d1a6..0c889520 100644 --- a/docs/user_guide/index.md +++ b/docs/user_guide/index.md @@ -104,6 +104,21 @@ This command will create a directory called `mycustomtheme`, which contains the The files are copied from the `classic` theme. You can update the contents of these files to create your custom theme. +To use your custom theme, update the `design.theme` field in the YAML input file as shown below. + +```yaml +cv: + ... + +design: + theme: mycustomtheme +``` + +Then, run the `render` command to render your CV with `mycustomtheme`. + +!!! note + Since JSON Schema will not recognize the name of the custom theme, it may show a warning in your IDE. This warning can be ignored. + Each of these `*.j2.tex` files is $\LaTeX$ code with some Python in it. These files allow RenderCV to create your CV out of the YAML input. The best way to understand how they work is to look at the templates of the built-in themes: