Skip to content

xiaozi0lei/cvless

 
 

Repository files navigation

cvless

Cvless is a theme for static websites built with Jekyll. It aims for simplicity and readability by following best practices of graphic design, like the use of high contrast, law of proximity, and responsive layout. Its typography is based on the Piazzolla system, which performs extremely well over a wide range of font sizes.

The main aesthetic feature of the theme is the use of particles.js in the home and the 404 pages. In addition, the theme includes a well-designed CV page. Printing this from browser automatically adapts the layout for a more traditional appearance, so you no longer have to maintain a separate CV for offline distribution. Finally, the theme offers a simple and easily extensible blog.

Light and dark modes are available. The theme initializes based on system preferences and stores the user's preference for the duration of the session.

See the demo to get a better sense of what the theme looks like.

Installation

  1. Clone this repository.
  2. Rename it to [username].github.io.
  3. Start editing!

Usage

Configuration primarily occurs in four files. First, _config.yml, which contains site variables such as title, tagline, url, and repository address, as well as the author's name and email address for inclusion in blog posts. You can also specify the path to an avatar for inclusion in the home (optional).

Second, you should update icon links in _includes/particles-home.html and add/remove icons as needed. You might want to add icons that are not included in the theme by default. For more information on how to do this, see this post.

Third, you should customize the file _includes/contact.html by inputting your contact details and adding/removing lines as needed. This information is prepended to your CV.

Fourth, you might want to edit the style variables specified in _sass/_variables.scss. These allow you to customize the theme's color scheme and typefaces. There are many resources on the web to learn the principles of good web design. I personally recommend Matthew Butterick's Practical Typography.

In addition to these files, you can customize favicons in the assets folder. For that, favicon.io is an excellent tool. You can also change the particles.js configurations in assets/json. The library homepage features an interactive tool from which you can export a new configuration.

Local Development

This repo includes a docker-compose file that allows you to quickly setup a container running Jekyll. If you don't already have Docker and docker-compose installed, you can install them using the following guides from Docker:

Install Guides

To start the container simply run:

docker-compose up

Alternatively you can run the container without docker-compose using the following command on Mac/Linux:

docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve

Credits

The theme draws in one way or another from the following projects:

Bugs

If you find any problem using this theme, please open an issue.

About

Jekyll theme for a beautiful online CV

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • SCSS 48.0%
  • HTML 27.8%
  • CSS 11.8%
  • JavaScript 11.6%
  • Ruby 0.8%