-
Notifications
You must be signed in to change notification settings - Fork 17
Adding a Community Hack
To add your own community hack, follow these instructions:
-
Fork the repository if you do not have push rights
-
Clone this forked repository onto your laptop.
-
Once you are inside the repository folder:
cd hacks/_posts/ -
cp 2013-12-12-example-hack.markdown yyyy-mm-dd-your-hack-title.MARKUPwhere yyyy-mm-dd is a tentative date of your hack and MARKUP can bemd,markdown,textile,html. Have a look at Jekyll docs to know more about writing posts in jekyll. -
Open the newly created file. You will notice there are 2 zones:
- Between the 3 Horizontal lines is the YAML front matter block. Have a look at Jekyll docs: front matter to know more about YAML Front matter in jekyll. In this block we have defined various variables which will be rendered automatically into the layout. Specify values for all the relevant/required variables and remove the remaining variables.
- Below the second set of
---is the main content. You can follow simple markdown to add content or revert back to basic html if you're comfortable. For markdown syntax refer to: Markdown reference. For textile you can check here
-
From the above YAML
layout,titleandcategoryare must. Rest are optional. -
In case of a single author, specify it as
author:[Author1] -
The content of the example hack shows quite a few examples of markdown syntax. Also all the required options are specified in the example.
-
After adding content, commit your changes. Once you are satisfied with the content, send a pull request. This can be done via the github web interface or any desktop interface you have. Once the pull request is merged into the master, your hack will be live.
Note If you have any doubts regarding this shoot a mailto: hiraysushant@gmail.com