mirror/rendercv
1
0
Fork 0
mirror of https://github.com/rendercv/rendercv.git synced 2026-04-23 00:11:20 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: update index.md

Browse Source
This commit is contained in:
Sina Atalay
2024-07-13 19:42:56 +03:00
parent 51cae8635e
commit 648f8e265c
1 changed files with 24 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

54
docs/index.md
View File

@@ -2,7 +2,7 @@
<div align="center" markdown="span">
*A* $\LaTeX$ *CV/resume framework*
*A* $\LaTeX$ *CV/Resume Framework*
<br>
<br>
@@ -17,7 +17,7 @@
RenderCV allows you to create a high-quality CV as a PDF from a YAML input file. It supports Markdown syntax and gives you complete control over the $\LaTeX$ code.
The primary motivation behind the RenderCV is to provide people with a concrete framework that allows
The primary motivation behind RenderCV is to provide a concrete framework that allows:
- Version controlling a CV's content and design separately and in an organized manner.
- Building an automated pipeline that updates the final output (PDF, $\LaTeX$, Markdown, HTML, and PNGs) whenever the content is modified.
@@ -35,8 +35,8 @@ cv:
sections:
this_is_a_section_title:
- This is a type of entry, TextEntry—just a plain string.
- You can have as many entries as you want under a section.
- RenderCV offers a variety of entry types, such as TextEntry,
- You may have as many entries as you want under a section.
- RenderCV offers a variety of entry types such as TextEntry,
BulletEntry, EducationEntry, ExperienceEntry, NormalEntry,
OneLineEntry, PublicationEntry.
- Each entry type has its own set of attributes and different
@@ -45,8 +45,8 @@ cv:
- institution: Boğaziçi University
area: Mechanical Engineering
degree: BS
start_date: 2000-09
end_date: 2005-05
start_date: 2024-09
end_date: 2029-05
highlights:
- 'GPA: 3.9/4.0 ([Transcript](https://example.com))'
- '**Coursework:** Structural Analysis, Thermodynamics,
@@ -57,18 +57,17 @@ cv:
Then, it produces one of these PDFs with its corresponding $\LaTeX$ code, Markdown file, HTML file, and images as PNGs. Each of these is an example of one of 4 built-in themes of RenderCV. Click on the images below to preview PDF files.
| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/classic.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/sb2nov.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) |
| [![Classic Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/classic.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [![Sb2nov Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/sb2nov.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [![Moderncv Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/moderncv.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [![Engineeringresumes Theme Example of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/engineeringresumes.png)](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) |
The contents of the HTML file can be pasted into Grammarly or any word processor for spelling and grammar checking.
![Grammarly for RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/grammarly.gif)
It also validates the input file, and if there are any problems, it tells users where the problems are and how they can fix them.
It also validates the input file. If there are any problems, it tells users where the problems are and how they can fix them.
![CLI of RenderCV](https://raw.githubusercontent.com/sinaatalay/rendercv/main/docs/assets/images/cli.gif)
@@ -87,7 +86,7 @@ Either use [rendercv-pipeline](https://github.com/sinaatalay/rendercv-pipeline)
```bash
pip install rendercv
```
3. Run the command below to generate a starting input files.
3. Run the command below to generate starting input files.
```bash
rendercv new "Full Name"
```
@@ -97,25 +96,25 @@ Either use [rendercv-pipeline](https://github.com/sinaatalay/rendercv-pipeline)
rendercv render Full_Name_CV.yaml
```
[Here](https://docs.rendercv.com/user_guide/), you can find a comprehensive user guide that covers the structure of the YAML input file and command-line interface (CLI) in greater detail.
[Here](https://docs.rendercv.com/user_guide/), you can find a comprehensive user guide that covers the YAML input file structure and command-line interface (CLI) in greater detail.
## Motivation
Writing the content of a CV and designing a CV are separate issues that should be treated separately. RenderCV attempts to provide this separation. This approach encourages users to concentrate on the content without getting distracted by the appearance of their CV and vice versa.
RenderCV also provides a general set of utilities that will automate most of the manual work involved in the CV updating process. After updating a single sentence or a date in the YAML input file written in pure English, RenderCV will
RenderCV also provides a set of utilities that automate most of the manual work involved in the CV updating process. After updating a single sentence or date in the YAML input file written in pure English, RenderCV will:
- re-create your $\LaTeX$ file,
- render a new PDF file,
- create a new Markdown file,
- create a new HTML document, and
- create images of each page of the PDF file as PNGs.
- Re-create your $\LaTeX$ file,
- Render a new PDF file,
- Create a new Markdown file,
- Create a new HTML document, and
- Create images of each page of the PDF file as PNGs.
> Why should I bother using RenderCV instead of $\LaTeX$? I can version-control $\LaTeX$ code too!
> Why use RenderCV instead of $\LaTeX$? I can version-control $\LaTeX$ code too!
RenderCV is not a replacement for $\LaTeX$, but it's a general set of utilities designed to create and manage $\LaTeX$ CVs. If you're currently using $\LaTeX$ to create your CV, you should try RenderCV. Using your existing $\LaTeX$ themes in RenderCV is very easy.
RenderCV is not a replacement for $\LaTeX$. It is a set of utilities designed to create and manage $\LaTeX$ CVs. If you're currently using $\LaTeX$ to create your CV, you should try RenderCV. Using your existing $\LaTeX$ themes in RenderCV is very easy.
Here are some advantages of RenderCV over using pure $\LaTeX$:
Advantages of RenderCV over using pure $\LaTeX$:
- RenderCV will separate the content of your CV from your $\LaTeX$ code. They will sit in independent files, and RenderCV will use both to generate your CV.
- You will be able to version-control your $\LaTeX$ code and content separately.
@@ -125,16 +124,11 @@ Here are some advantages of RenderCV over using pure $\LaTeX$:
## Documentation
The detailed user guide can be found [here](https://docs.rendercv.com/user_guide).
The developer guide can be found [here](https://docs.rendercv.com/developer_guide).
An overview of the source code can be found [here](https://docs.rendercv.com/reference).
The changelog can be found [here](https://docs.rendercv.com/changelog).
- [Detailed User Guide](https://docs.rendercv.com/user_guide)
- [Developer Guide](https://docs.rendercv.com/developer_guide)
- [Overview of Source Code](https://docs.rendercv.com/reference)
- [Changelog](https://docs.rendercv.com/changelog)
## Contributing
All contributions to RenderCV are welcome! To get started, please read [the developer guide](https://docs.rendercv.com/developer_guide).
The source code is thoroughly documented and well-commented, making it an enjoyable read and easy to understand.
All contributions to RenderCV are welcome! To get started, please read [the developer guide](https://docs.rendercv.com/developer_guide).