mirror/rendercv
1
0
Fork 0
mirror of https://github.com/rendercv/rendercv.git synced 2025-12-23 21:47:55 -05:00
Code Issues Packages Projects Releases Wiki Activity

docs: update the user guide

Browse Source
This commit is contained in:
Sina Atalay
2024-12-25 16:15:31 -05:00
parent 50cf3e7188
commit 1186d4ca41
1 changed files with 11 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
docs/user_guide/index.md
View File

@@ -14,7 +14,7 @@ This page provides everything you need to know about the usage of RenderCV.
pip install rendercv
```
## Getting started with the `new` command
## Getting started
To get started, navigate to the directory where you want to create your CV and run the command below to create the input files.
@@ -25,7 +25,7 @@ This command will create the following files:
- A YAML input file called `Your_Name_CV.yaml`.
This file contains the content and design options of your CV.
This file contains the content and design options of your CV. A detailed explanation of the structure of the YAML input file is provided [here](structure_of_the_yaml_input_file.md).
- A directory called `classic`.
@@ -35,16 +35,12 @@ This command will create the following files:
This directory contains the templates of RenderCV's default Markdown template. You can update its contents to tweak the Markdown and HTML output of the CV.
Please refer to the [here](cli.md#rendercv-new-command) for the complete list of CLI options available for the `new` command.
!!! info
Refer to the [here](cli.md#rendercv-new-command) for the complete list of CLI options available for the `new` command.
## Structure of the YAML input file
Then, open the `Your_Name_CV.yaml` file in your favorite text editor and fill it with your information. See the [structure of the YAML input file](structure_of_the_yaml_input_file.md) for more information about the YAML input file.
The YAML input file contains the content and design options of your CV. A detailed explanation of the structure of the YAML input file is provided [here](structure_of_the_yaml_input_file.md).
## Rendering the CV with the `render` command
To render a YAML input file, run the command below.
Finally, render the YAML input file to generate your CV.
```bash
rendercv render "Your_Name_CV.yaml"
@@ -59,9 +55,10 @@ This command will generate a directory called `rendercv_output`, which contains
- The CV in HTML format, `Your_Name_CV.html`. You can open this file in a web browser and copy-paste the content to Grammarly for proofreading.
- Some log and auxiliary files related to the $\LaTeX$ compilation process.
Please refer to the [here](cli.md#rendercv-render-command) for the complete list of CLI options available for the `render` command.
!!! info
Refer to the [here](cli.md#rendercv-render-command) for the complete list of CLI options available for the `render` command.
### Overriding built-in themes
## Overriding built-in themes
If the theme and Markdown templates are found in the directory, they will override the default built-in theme and Markdown templates. You don't need to provide all the files; you can just provide the ones you want to override.
@@ -180,4 +177,5 @@ RenderCV will then parse your custom design options from the YAML input. You can
((* endif *))
```
Please refer [here](cli.md#rendercv-create-theme-command) for the complete list of CLI options available for the `create-theme` command.
!!! info
Refer [here](cli.md#rendercv-create-theme-command) for the complete list of CLI options available for the `create-theme` command.