Changing the title of github pages

Octocat

If you are a frequent user of github, you might have come across github pages, a service  to publish websites. Github pages are often helpful to explain/showcase your small projects with a neat webpage for each repository.

  • All you need is to include a markdown in your github repository by name INDEX.md and github pages will generate a webpage from it. There are many options as mentioned in documentation.
  • 3 easy steps to setup a webpage for a project.
    • If you are using ipython notebook, download your notebook as a markdown file
    • place “markdown file+resources” in your github repository inside docs folder (create one if doesn’t exist).
    • Rename the markdown as docs/INDEX.md to make it the default loader. Your project website is ready at the link “[usename].github.io/[projectname]”
    • By default project webpage shows repository name as the title of webpage. This can be edited if you create/edit the _config.yml file and place this content inside as key:value pairs. Make sure the value is passed as a string in quotes.
      theme: jekyll-theme-cayman
      title: "Title of the project goes here"
      description: "Subtitle/description which comes after title goes here"
      show_downloads: true # displays download button on the .io page
      

You can even use this to publish a Web-resume (get a resume template from w3schools).

Learning GIT version control

git has undoubtedly become the version control standard in the industry and this skill is inevitable for collaboration across multiple teams. Even solo projects can use git to streamline development and experiment with multiple branches. This post is a small starting point for newbies.

git documentation can be overwhelming for most newbies  with lots of options/commands. In reality, most developers end up using a handful of key features.

[Since it is always hard to remember], I have this cheatsheet (atlassian) posted on my desk.

Another nifty little command on MAC terminal to get the graphical repository browser :

$ gitk

Git Commit messages

Git commit messages are terse notes about the changes made since last commit. ideally messages are to follow the structure given below and It’s always a good practice to follow this guide for commit messages: GIT Style Guide

type: [subject]

[body]

[footer]

Check out these awesome websites which can teach you git graphically.

Resources

  1. learngitbranching.js.org (highly recommended)
  2. Git-IT (Git is an excellent learn by doing cross-platform project)
  3. https://www.atlassian.com/git/tutorials/learn-git-with-bitbucket-cloud
  4. https://git-scm.com/book/en/v2/Git-Branching-Basic-Branching-and-Merging

Some useful links for beginners to get involved

  1. http://www.firsttimersonly.com/
  2. https://github.com/search?utf8=%E2%9C%93&q=label%3Afirst-timers-only+is%3Aopen&type=Issues&ref=searchresults
  3. Medium blog for first timers