Joel Glovier
51 lines
1.4 KiB
Markdown
51 lines
1.4 KiB
Markdown
# resume-template
|
|
|
|
*A simple Jekyll + GitHub Pages powered resume template.*
|
|
|
|
|
|
|
|
## Docs
|
|
|
|
### Customizing
|
|
|
|
First you'll want to fork the repo to your own account. Then clone it locally and customize, or use the GitHub web editor to customize. Much Most of the basic customization will take place in the `/_config.yml` file, and most of the content configuration will take place in the `/_layouts/resume.html` file
|
|
|
|
### Running locally
|
|
|
|
To test locally, run the following in your terminal:
|
|
|
|
1. Clone repo locally
|
|
1. `bundle install`
|
|
2. `bundle exec jekyll serve`
|
|
3. Open your browser to `localhost:4000`
|
|
|
|
### Publishing to GitHub Pages for free
|
|
|
|
...write me...
|
|
|
|
### Configuring with your own domain name
|
|
|
|
...write me...
|
|
|
|
### Themes
|
|
|
|
Right now resume-template only has one theme. More are coming :soon: though. :heart:
|
|
|
|
## Roadmap
|
|
|
|
- [ ] Add print button/styles
|
|
- [ ] Add PDF button/functionality
|
|
- [ ] Add more theme styles
|
|
- [ ] Add a "fork me on GitHub" thing
|
|
- [ ] Finish docs
|
|
- [ ] Cleanup CSS
|
|
|
|
## Contributing
|
|
|
|
...write me...
|
|
|
|
## License
|
|
|
|
The code and styles are licensed under the MIT license. [See project license.](LICENSE) Obviously you should not use the content of this demo repo in your own resume. :wink:
|
|
|
|
Disclaimer: Use of Homer J. Simpson image and name used under [Fair Use](https://en.wikipedia.org/wiki/Fair_use) for educational purposes. Project license does not apply to use of this material. |