diff --git a/docs/images/EducationEntry.png b/docs/assets/images/EducationEntry.png similarity index 100% rename from docs/images/EducationEntry.png rename to docs/assets/images/EducationEntry.png diff --git a/docs/images/ExperienceEntry.png b/docs/assets/images/ExperienceEntry.png similarity index 100% rename from docs/images/ExperienceEntry.png rename to docs/assets/images/ExperienceEntry.png diff --git a/docs/images/NormalEntry.png b/docs/assets/images/NormalEntry.png similarity index 100% rename from docs/images/NormalEntry.png rename to docs/assets/images/NormalEntry.png diff --git a/docs/images/OneLineEntry.png b/docs/assets/images/OneLineEntry.png similarity index 100% rename from docs/images/OneLineEntry.png rename to docs/assets/images/OneLineEntry.png diff --git a/docs/images/PublicationEntry.png b/docs/assets/images/PublicationEntry.png similarity index 100% rename from docs/images/PublicationEntry.png rename to docs/assets/images/PublicationEntry.png diff --git a/docs/javascripts/katex.js b/docs/assets/javascripts/katex.js similarity index 100% rename from docs/javascripts/katex.js rename to docs/assets/javascripts/katex.js diff --git a/docs/images/example.png b/docs/images/example.png deleted file mode 100644 index a91b264..0000000 Binary files a/docs/images/example.png and /dev/null differ diff --git a/docs/index.md b/docs/index.md index 6afe712..df04e54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,86 +1 @@ -# RenderCV -[![CI](https://github.com/sinaatalay/rendercv/actions/workflows/ci.yaml/badge.svg?branch=main)](https://github.com/sinaatalay/rendercv/actions/workflows/ci.yaml) -[![coverage](https://coverage-badge.samuelcolvin.workers.dev/sinaatalay/rendercv.svg)](https://coverage-badge.samuelcolvin.workers.dev/redirect/sinaatalay/rendercv) -[![pypi-version](https://img.shields.io/pypi/v/rendercv?label=PyPI%20version&color=rgb(0%2C79%2C144))](https://pypi.python.org/pypi/rendercv) -[![pypi-downloads](https://img.shields.io/pepy/dt/rendercv?label=PyPI%20downloads&color=rgb(0%2C%2079%2C%20144))](https://pypi.python.org/pypi/rendercv) - - -RenderCV is a Python application that creates a $\LaTeX$ CV as a PDF from a JSON/YAML input file. Currently, it only supports one theme (*classic*). An example PDF can be seen [here](https://github.com/sinaatalay/rendercv/blob/main/John_Doe_CV.pdf?raw=true). More themes are planned to be supported in the future. - -**What does it do?** - -- It parses a YAML (or JSON) file that looks like this: -```yaml -cv: - name: John Doe - label: Mechanical Engineer - location: Geneva, Switzerland - email: johndoe@example.com - phone: "+33749882538" - website: https://example.com - social_networks: - - network: GitHub - username: johndoe - - network: LinkedIn - username: johndoe - education: - - institution: My University - url: https://example.com - area: Mechanical Engineering - degree: BS - location: Geneva, Switzerland - start_date: "2017-09-01" - end_date: "2023-01-01" - transcript_url: https://example.com - gpa: 3.10/4.00 - highlights: - - "Class rank: 10 of 62" - - institution: The University of Texas at Austin - url: https://utexas.edu - area: Mechanical Engineering, Student Exchange Program - location: Austin, TX, USA - start_date: "2021-08-01" - end_date: "2022-01-15" - work_experience: - - company: AmIACompany - position: Summer Intern - location: Istanbul, Turkey - url: https://example.com - start_date: "2022-06-15" - end_date: "2022-08-01" - highlights: - - AmIACompany is a **technology** (markdown is - supported) company that provides web-based - engineering applications that enable the - simulation and optimization of products and - manufacturing tools. - - Modeled and simulated a metal-forming process deep - drawing using finite element analysis with - open-source software called CalculiX. -``` -- Then, it validates the input, such as checking if the dates are consistent, checking if the URLs are correct, etc. -- Then, it creates a $\LaTeX$ file. -- Finally, it renders the $\LaTeX$ file to generate the PDF, and you don't need $\LaTeX$ installed on your PC because RenderCV comes with [TinyTeX](https://yihui.org/tinytex/). - -![RenderCV example](images/example.png) - -## Quick Start Guide - -1. Install [Python](https://www.python.org/downloads/) (3.10 or newer). -2. Run the command below to install RenderCV. - ```bash - pip install rendercv - ``` -3. Run the command below to generate a sample input file (`Full_Name_CV.yaml`). The file will be generated in the current working directory. - ```bash - rendercv new "Full Name" - ``` -4. Edit the contents of the `Full_Name_CV.yaml` file. -5. Run the command below to generate your $\LaTeX$ CV. - ```bash - rendercv render Full_Name_CV.yaml - ``` - -## Contributing - -All contributions to RenderCV are welcome, especially adding new $\LaTeX$ themes. +gest \ No newline at end of file diff --git a/docs/user_guide.md b/docs/user_guide.md index 96558d2..619db36 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -86,7 +86,7 @@ highlights: which renders into -![EducationEntry](images/EducationEntry.png) +![EducationEntry](assets/images/imagesEducationEntry.png) ### *ExperienceEntry* @@ -107,7 +107,7 @@ highlights: which renders into -![ExperienceEntry](images/ExperienceEntry.png) +![ExperienceEntry](assets/images/imagesExperienceEntry.png) ### *NormalEntry* @@ -124,7 +124,7 @@ url: https://example.com which renders into -![NormalEntry](images/NormalEntry.png) +![NormalEntry](assets/images/imagesNormalEntry.png) ### *OneLineEntry* ```yaml @@ -134,7 +134,7 @@ details: C++, C, Python, JavaScript, MATLAB, Lua, LaTeX which renders into -![OneLineEntry](images/OneLineEntry.png) +![OneLineEntry](assets/images/imagesOneLineEntry.png) ### *PublicationEntry* @@ -152,7 +152,7 @@ cited_by: 243 which renders into -![PublicationEntry](images/PublicationEntry.png) +![PublicationEntry](assets/images/imagesPublicationEntry.png) ## Custom Sections diff --git a/mkdocs.yaml b/mkdocs.yaml index 4e64713..fa10bd9 100644 --- a/mkdocs.yaml +++ b/mkdocs.yaml @@ -1,4 +1,4 @@ -site_name: "RenderCV" +site_name: RenderCV site_description: LaTeX CV generator engine from a YAML input file. site_author: Sina Atalay copyright: Copyright © 2023 Sina Atalay @@ -9,7 +9,6 @@ edit_uri: edit/main/docs/ theme: name: material - custom_dir: docs palette: - media: "(prefers-color-scheme: light)" scheme: default @@ -80,12 +79,12 @@ plugins: members_order: source show_bases: true docstring_section_style: list - # merge_init_into_class: true + merge_init_into_class: true show_docstring_attributes: true docstring_style: google extra_javascript: - - javascripts/katex.js + - assets/javascripts/katex.js - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js