Difference between revisions of "Github"

From Hacksburg Wiki
Jump to navigation Jump to search
(Created page with "Hacksburg maintains a Github organization [https://github.com/Hacksburg here]. == Github == Board members should get push access to the Hacksburg repositories. For this, the...")
(No difference)

Latest revision as of 13:29, 24 May 2020

Hacksburg maintains a Github organization here.


Board members should get push access to the Hacksburg repositories. For this, they will need to make a Github account (if they don't have one already). Members pushing to repos should use Git or some UI equivalent (eg, TortoiseGit for Windows).

A full Git tutorial is beyond the scope of this document, but in general, here's how you do things with regular command-line Git (TortoiseGit and other GUI-based Git clients will be different!).

To work on a repository, you must first clone it by running

<file> git clone [url] </file>

where [url] is the URL of the repository. This will create a subdirectory with the contents of the repository in it.

Github Pages

The Hacksburg website lives at hacksburg.org. It's hosted on Github's servers (thereby taking advantage of Github's good uptime). The repository is here.

Posting to the Site

The site is built using Jekyll, so to write a new post you will need to be added to the Hacksburg GitHub group. Once you have access to that, clone the repository locally. Then, copy the format of one of the existing articles in the _posts/ directory, including the filename convention. Next, update the date and time of the filename to the current date and time, and change the title to something more meaningful (Ex: 2015-06-02-1556-post_title.markdown).

Change the data in the "frontmatter" (the section between the lines containing only dashes) to match your new post, and then write the remaining article in Markdown syntax. When you've done that, 'git add' the file you made, 'git commit' with a message about the article you wrote, and 'git push origin master' to get github to rebuild the page.

If you want to include images, put them in the images/ directory and reference them in the article as "/images/[filename]".

Blog style

The style of the blog uses Bootstrap to make it adaptive ('responsive'), and is based heavily on the example blog template provided on Bootstrap's home page. A number of changes have been made to this template. If you'd like to redesign or modify the design, it is probably a good idea to get acquainted with the Bootstrap documentation beforehand, as well as HTML and CSS, so you can make the changes in a sensible way.