mirror of
https://github.com/rendercv/rendercv.git
synced 2026-10-22 20:34:44 -04:00
docs: update index.md
This commit is contained in:
1 parent
e73f13e816
commit
4c51621141
1 file changed
+5
-8
+5
-8
@@ -1,10 +1,12 @@
|
||||
# RenderCV
|
||||
|
||||
<div align="center" markdown="span">
|
||||
[](https://github.com/sinaatalay/rendercv/actions/workflows/test.yaml)
|
||||
[](https://coverage-badge.samuelcolvin.workers.dev/redirect/sinaatalay/rendercv)
|
||||
[)](https://docs.rendercv.com)
|
||||
[)](https://pypi.python.org/pypi/rendercv)
|
||||
[)](https://pypistats.org/packages/rendercv)
|
||||
</div>
|
||||
|
||||
RenderCV is a $\LaTeX$ CV/resume framework. It allows you to create a high-quality CV as a PDF from a YAML file with full Markdown syntax support and complete control over the $\LaTeX$ code.
|
||||
|
||||
@@ -23,11 +25,6 @@ cv:
|
||||
name: John Doe
|
||||
location: Your Location
|
||||
email: youremail@yourdomain.com
|
||||
social_networks:
|
||||
- network: LinkedIn
|
||||
username: yourusername
|
||||
- network: GitHub
|
||||
username: yourusername
|
||||
sections:
|
||||
this_is_a_section_title:
|
||||
- This is a type of entry, TextEntry—just a plain string.
|
||||
@@ -54,7 +51,7 @@ cv:
|
||||
Then, it produces one of these PDFs with its corresponding $\LaTeX$ code, markdown file, and images as PNGs. Each of these is an example of one of four built-in themes of RenderCV. Click on images to preview PDFs.
|
||||
|
||||
| [](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_ClassicTheme_CV.pdf) | [](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_Sb2novTheme_CV.pdf) |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| [](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_ModerncvTheme_CV.pdf) | [](https://github.com/sinaatalay/rendercv/blob/main/examples/John_Doe_EngineeringresumesTheme_CV.pdf) |
|
||||
|
||||
|
||||
@@ -106,7 +103,7 @@ RenderCV also provides a general set of utilities that will automate most of the
|
||||
- create a new HTML document to be pasted into word processors for spelling and grammar checking.
|
||||
- create PNG files for each page.
|
||||
|
||||
### Why should I bother using RenderCV instead of $\LaTeX$? I can version-control $\LaTeX$ code too!
|
||||
> Why should I bother using 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.
|
||||
|
||||
@@ -138,4 +135,4 @@ All contributions to RenderCV are welcome! For development, you will need to clo
|
||||
git clone --recursive https://github.com/sinaatalay/rendercv.git
|
||||
```
|
||||
|
||||
All code and development tool specifications are in `pyproject.toml`. Also, don't forget to read [the developer guide](https://docs.rendercv.com/developer_guide).
|
||||
All code and development tool specifications are in `pyproject.toml`. Also, don't forget to read [the developer guide](https://docs.rendercv.com/developer_guide).
|
||||
Reference in new issue
Block a user