A python-based static site generator for setting up a CV/Resume site
MIT License
A python-based static site generator for setting up a CV/Resume site
ezcv is a purpose built static site generator for creating personal resume/portfolio/cv sites
ezcv is a great choice if:
ezcv is not a great choice if:
Here's everything you need to know to get started with ezcv.
Note that there is an option to develop a site completely on your browser without needing to install anything or know how to use git. For details on setting this up, please visit https://ezcv.readthedocs.io/en/latest/quick-start/#remote-editing.
To use ezcv you will need python 3.6+ (earlier versions wont work) and pip for python 3.
pip install ezcv
pip install .
or sudo pip3 install .
in the root directoryThe easiest way to get started is by running:
ezcv init <name>
Replacing the <name>
argument with your name (use "" if you want to use your full name i.e. ezcv init "Kieran Wood"
).
When you run the command a new folder will be created with your name, and some starter files like this:
Legend
Icon | Meaning |
---|---|
📁 | File Folder |
📷 | Image file |
📝 | File you should edit/delete |
📄 | File you don't need to edit/shouldn't delete |
📁<name>/
├── 📁.github/
│ └── 📁workflows/
│ └── 📄ezcv-publish.yml
├── 📁content/
│ ├── 📁education/
│ | ├── 📝example-current.md
│ | └── 📝example-old.md
│ ├── 📁projects/
│ | └── 📝example.md
│ ├── 📁volunteering_experience/
│ | ├── 📝example-current.md
│ | └── 📝example-old.md
│ └── 📁volunteering_experience/
│ ├── 📝example-current.md
│ └── 📝example-old.md
├── 📁images/
│ ├── 📷 abstract-landscape.jpg
│ └── 📷 ice-caps.jpg
├── 📄.gitignore
└── 📝config.yml
From here you can go into your config.yml
file and pick a theme, then start filling out your content according to what's available for the theme.
To preview your content use:
ezcv -p
If you're on github then pushing the contents to master/main will activate the publish workflow and automatically publish the site to <username>.github.io
.
Usage:
ezcv [-h] [-v] [-p]
ezcv build [-d OUTPUT_DIR] [-o]
ezcv init [<name>] [<theme>] [-f]
ezcv theme [-l] [-c] [-m] [<theme>]
ezcv section <SECTION_NAME> [-t=<type>]
Options:
-h, --help show this help message and exit
-v, --version show program's version number and exit
-l, --list list the possible themes
-c, --copy copy the provided theme, or defined site theme
-p, --preview preview the current state of the site
-o, --optimize Optimize output files (takes longer to run)
-f, --flask Generate Flask routes and requirements.txt
-d OUTPUT_DIR, --dir OUTPUT_DIR The folder name to export the site to
-m, --metadata Generate metadata for the theme
-t=<type>, --type=<type> The type of section to generate [default: markdown]
See the CLI Documentation for additional details
Template repository for bootstrapping projects
Template repository for ezcv integrated with flask
See documentation for included themes for examples of each of the included themes