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 README.md and index.md

Browse Source
This commit is contained in:
Sina Atalay
2025-01-07 14:31:29 +03:00
parent 8b181d1e6b
commit b0f173b598
2 changed files with 50 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

45
README.md
View File

@@ -25,28 +25,33 @@ It takes a YAML file that looks like this:
```yaml
cv:
name: John Doe
location: Your Location
email: youremail@yourdomain.com
location: Location
email: john.doe@example.com
phone: tel:+1-609-999-9995
social_networks:
- network: LinkedIn
username: john.doe
- network: GitHub
username: john.doe
sections:
this_is_a_section_title:
- This is a type of entry, TextEntry—just a plain string.
- 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
looks.
my_education_section:
- institution: Boğaziçi University
area: Mechanical Engineering
degree: BS
start_date: 2024-09
end_date: 2029-05
welcome_to_RenderCV!:
- '[RenderCV](https://rendercv.com) is a Typst-based CV
framework designed for academics and engineers, with Markdown
syntax support.'
- Each section title is arbitrary. Each section contains
a list of entries, and there are 7 different entry types
to choose from.
education:
- institution: Stanford University
area: Computer Science
degree: PhD
location: Stanford, CA, USA
start_date: 2023-09
end_date: present
highlights:
- "GPA: 3.9/4.0 ([Transcript](https://example.com))"
- "**Coursework:** Structural Analysis, Thermodynamics,
Heat Transfer"
experience: ...
- Working on the optimization of autonomous vehicles
in urban environments
...
```
Then, it produces one of these PDFs with its corresponding Typst file, Markdown file, HTML file, and images as PNGs. Click on the images below to preview PDF files.

45
docs/index.md
View File

@@ -20,28 +20,33 @@ It takes a YAML file that looks like this:
```yaml
cv:
name: John Doe
location: Your Location
email: youremail@yourdomain.com
location: Location
email: john.doe@example.com
phone: tel:+1-609-999-9995
social_networks:
- network: LinkedIn
username: john.doe
- network: GitHub
username: john.doe
sections:
this_is_a_section_title:
- This is a type of entry, TextEntry—just a plain string.
- 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
looks.
my_education_section:
- institution: Boğaziçi University
area: Mechanical Engineering
degree: BS
start_date: 2024-09
end_date: 2029-05
welcome_to_RenderCV!:
- '[RenderCV](https://rendercv.com) is a Typst-based CV
framework designed for academics and engineers, with Markdown
syntax support.'
- Each section title is arbitrary. Each section contains
a list of entries, and there are 7 different entry types
to choose from.
education:
- institution: Stanford University
area: Computer Science
degree: PhD
location: Stanford, CA, USA
start_date: 2023-09
end_date: present
highlights:
- "GPA: 3.9/4.0 ([Transcript](https://example.com))"
- "**Coursework:** Structural Analysis, Thermodynamics,
Heat Transfer"
experience: ...
- Working on the optimization of autonomous vehicles
in urban environments
...
```
Then, it produces one of these PDFs with its corresponding Typst file, Markdown file, HTML file, and images as PNGs. Click on the images below to preview PDF files.