diff --git a/docs/changelog.md b/docs/changelog.md index 1c4b6e8..0592cc5 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -28,79 +28,19 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/). ``` - [A developer guide](https://docs.rendercv.com/developer_guide/) has been written. - New options have been added to the `rendercv render` command: - - `--use-local-latex-command "LATEX_COMMAND"`: Generates the CV with the local $\LaTeX$ installation, i.e., runs `LATEX_COMMAND`. By default, RenderCV uses its own TinyTeX distribution. - ```bash - rendercv render "Your_Name_CV.yaml" --use-local-latex-command "pdflatex" - ``` - `--output-folder-name "OUTPUT_FOLDER_NAME"`: Generates the output files in a folder with the given name. By default, the output folder name is `rendercv_output`. The output folder will be created in the current working directory. ([#58](https://github.com/sinaatalay/rendercv/issues/58)) - ```bash - rendercv render "Your_Name_CV.yaml" --output-folder-name "OUTPUT_FOLDER_NAME" - ``` - - `--latex-path LATEX_PATH`: Copies the generated $\LaTeX$ source code from the output folder and pastes it to the specified path. - ```bash - rendercv render "Your_Name_CV.yaml" --latex-path "PATH" - ``` - - `--pdf-path PDF_PATH`: Copies the generated PDF file from the output folder and pastes it to the specified path. - ```bash - rendercv render "Your_Name_CV.yaml" --pdf-path "PATH" - ``` - - `--markdown-path MARKDOWN_PATH`: Copies the generated Markdown file from the output folder and pastes it to the specified path. - ```bash - rendercv render "Your_Name_CV.yaml" --markdown-path "PATH" - ``` - - `--html-path HTML_PATH`: Copies the generated HTML file from the output folder and pastes it to the specified path. - ```bash - rendercv render "Your_Name_CV.yaml" --html-path "PATH" - ``` - - `--png-path PNG_PATH`: Copies the generated PNG files from the output folder and pastes them to the specified path. - ```bash - rendercv render "Your_Name_CV.yaml" --png-path "PATH" - ``` - - `--dont-generate-markdown`: Prevents the generation of the Markdown file. - ```bash - rendercv render "Your_Name_CV.yaml" --dont-generate-markdown - ``` - - `--dont-generate-html`: Prevents the generation of the HTML file. - ```bash - rendercv render "Your_Name_CV.yaml" --dont-generate-html - ``` - - `--dont-generate-png`: Prevents the generation of the PNG files. - ```bash - rendercv render "Your_Name_CV.yaml" --dont-generate-png - ``` - - - `--ANY.LOCATION.IN.THE.YAML.FILE "VALUE"`: Overrides the value of `ANY.LOCATION.IN.THE.YAML.FILE` with `VALUE`. This option can be used to avoid storing sensitive information in the YAML file. Sensitive information, like phone numbers, can be passed as a command-line argument with environment variables. This method is also beneficial for creating multiple CVs using the same YAML file by changing only a few values. Here are a few examples: - ```bash - rendercv render "Your_Name_CV.yaml" --cv.phone "+905555555555" - ``` - ```bash - rendercv render "Your_Name_CV.yaml" --cv.sections.education.1.institution "Your University" - ``` - - Multiple `--ANY.LOCATION.IN.THE.YAML.FILE "VALUE"` options can be used in the same command. + - `--ANY.LOCATION.IN.THE.YAML.FILE "VALUE"`: Overrides the value of `ANY.LOCATION.IN.THE.YAML.FILE` with `VALUE`. This option can be used to avoid storing sensitive information in the YAML file. Sensitive information, like phone numbers, can be passed as a command-line argument with environment variables. This method is also beneficial for creating multiple CVs using the same YAML file by changing only a few values. - New options have been added to the `rendercv new` command: - - `--theme "THEME_NAME"`: Generates files for a specific built-in theme, instead of the default `classic` theme. - ```bash - rendercv new "Your Full Name" --theme "THEME_NAME" - ``` - - `--dont-create-theme-source-files`: Prevents the creation of the theme source files. By default, the theme source files are created. - ```bash - rendercv new "Your Full Name" --dont-create-theme-source-files - ``` - - `--dont-create-markdown-source-files`: Prevents the creation of the Markdown source files. By default, the Markdown source files are created. - ```bash - rendercv new "Your Full Name" --dont-create-markdown-source-files - ``` ### Changed - Package size has been reduced by removing unnecessary TinyTeX files.