https://github.com/ankitsultana/researcher

A jekyll based resume template
https://github.com/ankitsultana/researcher

blog-theme gh-pages jekyll jekyll-theme monospace resume

Last synced: about 1 month ago
JSON representation

A jekyll based resume template

• Host: GitHub
• URL: https://github.com/ankitsultana/researcher
• Owner: ankitsultana
• License: gpl-3.0
• Created: 2016-08-29T16:23:36.000Z (about 8 years ago)
• Default Branch: gh-pages
• Last Pushed: 2024-04-03T11:42:34.000Z (7 months ago)
• Last Synced: 2024-09-28T02:41:02.496Z (about 2 months ago)
• Topics: blog-theme, gh-pages, jekyll, jekyll-theme, monospace, resume
• Language: HTML
• Homepage: https://ankitsultana.github.io/researcher
• Size: 382 KB
• Stars: 641
• Watchers: 11
• Forks: 606
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Researcher

### [Demo Website](http://ankitsultana.com/researcher)

A clean, single column, monospace resume template built for jekyll

### Installation

Simply fork the repository and edit away.

#### Installation via remote themes

* Just setting `remote_theme: ankitsultana/researcher@gem` in `_config.yml` should work. Although in that case, I am not sure how

you would build your site locally for testing. If you know how, open up an issue and let me know.

* For more info, [refer this](https://blog.github.com/2017-11-29-use-any-theme-with-github-pages/).

### Customization

* You can edit the `.md` (markdown) files as you see fit. You can also add some other markdown file, say `foo.md` in the root directory of the repository. It will then be accessible like so `{{ url of your website }}/foo`.

* You can of course remove `contact.md` if you don't want it

* To set the heading, edit the `title` variable in `_config.yml`

* To edit the `links` mentioned on the navigation bar, you can edit `_config.yml`. For example:

```

nav:

 - name: "About"

   link: "/researcher/"

 - name: "Resume"

   link: "resume.pdf"

 - name: "Contact"

   link: "contact"

```

* You can change the accent (color of hyperlinks) by editing the `accent` variable in `_sass/vars.scss`

* You can setup google analytics, by setting `tracking_id` in `_config.yml`

* To add a profile picture, make sure to give the image tag the class `profile-picture`. In other words,do it like so:

```html



```

* You can remove/customize the footer as you like by setting the

appropriate variables in `_config.yml`

* (New in v1.2.0) You can add institute logo at the top, by setting `ins_logo` in `_config.yml`. If you want

to adjust the logo's size, try setting `max-height` in `#ins-logo` in file `./_sass/_style.scss` to the desired

value

![Institute Logo Image Sample](https://github.com/ankitsultana/assets/raw/master/ins-logo-sample.png)

**Note:** Customizing the accent color might cause merge conflicts if you later try to merge from `bk2dcradle/researcher` to fetch updates/patches etc. (applicable only if you have forked).

### License

[GNU GPL v3](https://github.com/bk2dcradle/researcher/blob/gh-pages/LICENSE)