GDG Chennai's New Website #Reboot
Switch branches/tags
Nothing to show
Clone or download
swaathi Merge pull request #9 from imkarthikk/master
New Contribution.md and Updated Readme.md
Latest commit 1424b0d Jun 24, 2016
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
WTM16 Site Updated - Few Fixes in WTM Mar 5, 2016
_site Site Updated - Few Fixes in WTM Mar 5, 2016
css Site Updated - Few Fixes in WTM Mar 5, 2016
fonts New Codebase Feb 20, 2015
images Site Updated - Few Fixes in WTM Mar 5, 2016
js GDG Women Mar 4, 2016
.DS_Store Site Updated - Few Fixes in WTM Mar 5, 2016
.dropbox New Codebase Feb 20, 2015
CNAME CNAME update Feb 27, 2015
CONTRIBUTING.md Update CONTRIBUTING.md Jun 2, 2016
LICENSE Create LICENSE May 31, 2016
README.md Huge update to Readme Jun 24, 2016
about.html Menu update Feb 27, 2015
index.html Update index.html Mar 21, 2016

README.md

GDG Chennai

The site uses Jekyll, a static site generator. GitHub Pages, where the site is hosted, natively supports Jekyll so every time someone pushes to this repository, the website will be built and updated. For hosting it yourself, see Setting up a local copy of the website.

Contribution Guidelines

Note: Major issues or feature requests should be filed on the issue tracker first. Once you raise the request, the community moderators and other awesome members will come together to review the issue/feature request.

If you would like to make minor change:

  1. Fork this repo
  2. Click on the file you would like to edit from your Github page
  3. Click on the small Edit icon towards the top right of the file view
  4. GitHub's editor allows you to write in Markdown as well as other languages, but there are no validations in place.
  5. Once you are done editing, enter a brief summary and description about the change you have made, and issue a Pull Request to the master repo.

If you would like to make some major change: For largest changes, GitHub's in-browser editor might not be the solution. The best way to do that is to setup a local clone of the website, and work on it using your favorite editor like Sublime or Atom.

Then, setup the local Developer Environment

  1. Fork this repo
  2. Clone your newly forked repo to your local machine
  3. Open Terminal, and run cd gdgchennai
  4. Now, install the dependencies: bundle install
  5. Now, run bundle exec jekyll serve - builds the website and runs a local webserver on port 400
  6. Once you are done working, raise pull requests to skcript/GDGChennai

Note: you can add the --watch option when running jekyll serve to let Jekyll watch for file changes, which means the site will be rebuilt when a file is modified.

Note 2: on case-insensitive file systems like on Windows and Mac OS X you'll run into redirect loops for some URLs. The workaround is to disable redirects locally by removing the gems: jekyll-redirect-from entry from _config.yml.

Setting up Developer Environment

Dependencies

  • Ruby - Jekyll is written in Ruby
  • Bundler - a package manager for Ruby. Install it by running gem install bundler

Repository structure

  • _includes - special folder contains snippets that can be included via {% include file.html %} in other pages
  • _layouts - special folder contains the layouts that are shared between pages. Layouts can be inherited, the root layout is base.html.
  • _posts - special folder, contains the source pages for the blog section, see Writing a blog post
  • _site - the output of the generated site is stored here by default, this folder only exists after Jekyll built the site
  • archived - content that is no longer relevant but kept to keep external links working
  • community - contains the source pages for the /community website section
  • css - contains the main stylesheet
  • docs - contains the source pages for the /docs website section
  • download - contains the source pages for the /download website section
  • files - stores binary files used in pages
  • images - stores the images used in pages
  • news - lists the blog pages from the _posts directory