ankitsultana / researcher

A jekyll based resume template

Researcher

Demo Website

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.

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:

<img class="profile-picture" src="sherlock.jpg">

• 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

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

researcher's Issues

Problems with line spacing in text

What should I do if I want the text to be more line spaced 😅?

demo website down

The demo website seem to be down, have you consider using github pages as an demo site?

author-name link does not link to homepage

I noticed that the author-name link on the upper left is not a static link to the homepage, but it links to the current site instead.

Is there a way to fix this?

Logo of institute in the navbar

Hi @ankitsultana and all,

does the theme provide a way to also put a logo of the institute in the navbar?

For example, by putting some specific item under nav:?

Many thanks for your work...

Using html code?

Hi,

I want to use html code in my website. Is this possible?

Clicking the title doesn't redirect to the front page.

Hi Ankit, thanks for sharing your theme, first of all. I keep having this problem even when I minimally modify your theme. When I click the "title" of the webpage, it doesn't reload the front page but is stuck at whatever page it was at currently. For example, if I go to "contact" and then click the title again, it does not go back to the front page(i.e., index.md). Any ideas what causes this behavior? The site is here.

Local test

How can we test the website building locally? And how can we change the font size of div width?

Syntax highlighting

Standard kramdown syntax highlighting is broken for some reason.

Broken links in navbar

The links in the top-right navbar are wrong when accessed from a custom page. For instance, if I add a page test.md and try to access the contact page then I'm redirected to https://mysite.github.io/test/contact instead of https://mysite.github.io/contact.

I suspect that the bug comes from this line but I didn't figure out how to fix it.

This is somewhat related to issue #20.

Accessibility errors found in your template

The user @carlsonsantana validate your site template "https://ankitsultana.com/researcher/" and found these accessibility errors:

• Page https://ankitsultana.com/researcher/:
  • Issue 3c3f3f18-e6f9-40c3-bd2a-2bc95354dbe5:
    • Type: Error
    • Code: WCAG2AA.Principle1.Guideline1_1.1_1_1.H37
    • Message: Img element missing an alt attribute. Use the alt attribute to specify a short text alternative.
    • Selector: html > body > div > div:nth-child(4) > p:nth-child(2) > img
    • Context: <img class="profile-picture" src="sherlock.jpg">

You can check these accessibility errors using pa11y.
You can view the full validation results in our website.

Theme requires to load 'unsafe scripts' in Google Chrome

-- solved: typo in the source_link (_config)

Issues using as a remote-theme hosted on github pages

Hey @ankitsultana , thank you for a nice theme. Very glad to use it!

I'm trying to migrate to github pages and wish to use your repo as a remote-theme. When trying to use it as a remote theme I get:

Invalid theme folder: _sass Remote Theme: Using theme ankitsultana/researcher jekyll 3.8.3 | Error: 404 - Not Found

Is the theme intended to be used remotely and if yes, how so? If not I'd gladly give a hand preparing it to be used in such a manner.

Sincerely,
Frederik