namecard

namecard is a markdown-driven, single page CV

markdown-driven: all of the content and most of the styling on the site can be edited with markdown, which is flexible and easy to use

single page: a single page is concise and doesn't overwhelm visitors - see the KISS principle

Usage

Usage instructions and theme options are available at https://github.com/afterdusk/use-namecard, an example site using namecard. I highly recommend cloning the repository and editing the content from the template instead of performing an install on an existing repo.

Installation

There are two ways of installing Jekyll themes:

1. Gem Installation

---

Note that this approach will not work with GitHub Pages build and deploy. If you are using this approach and want to deploy with GitHub Pages, you will have to build your site locally and only push the output _site folder.

---

Add this line to your Jekyll site's Gemfile:

gem "namecard"

And add this line to your Jekyll site's _config.yml:

theme: namecard

And then execute:

$ bundle

Or install it yourself with:

$ gem install namecard

2. GitHub Pages Remote Theme

If you plan to deploy with GitHub Pages, this is the far simpler approach of adding the theme to your site. Add the following line to your site's _config.yml:

remote_theme: afterdusk/namecard

In your Gemfile, ensure the following lines are commented out:

# gem "namecard"
# gem "jekyll", "~> 3.8.5"

And uncomment the line:

gem "github-pages", "~> 204", group: :jekyll_plugins

Note: Make sure a version number is included in the above line

You can then test the site locally before deploying to GitHub pages.

Contributing

Bug reports, suggestions and pull requests are welcome on GitHub at https://github.com/afterdusk/namecard. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.