Book Image

GitHub Essentials

By : Achilleas Pipinellis
Book Image

GitHub Essentials

By: Achilleas Pipinellis

Overview of this book

<p><span id="description" class="sugar_field">Whether you are an experienced developer or a novice, learning to work with Version Control Systems is a must in the software development world. Git is the most popular tool for that purpose and GitHub was built around it leveraging its powers by bringing it to the web.</span></p> <p><span id="description" class="sugar_field">Starting with the basics of creating a repository you will then learn how to manage the issue tracker, the place where discussion about your project takes place. Continuing our journey we will explore how to use the wiki and write rich documentation that will accompany your project. Organization and team management will be the next stop and then onto the feature that made GitHub so well known, Pull Requests. Next we focus on creating simple web pages hosted on GitHub and lastly we explore the settings that are configurable for a user and a repository.</span></p>
Table of Contents (13 chapters)

Using the wiki


When you first create a new repository, a wiki attached to this project is also created. It is enabled by default and everyone can add new content or modify existing pages. If you want to change this behavior, refer to Chapter 6, Exploring the User and Repository Settings, which shows how to accomplish this.

Why wikis are a nice place to document your project

Documentation is not to be taken lightly. To paraphrase a famous quote: "With great projects comes great documentation."

Although there are many tools that convert markup files, such as markdown to HTML, you may not want to use an external page to host your documentation. Enter GitHub wiki.

Create a new wiki page

From the right-hand side bar, select the wiki tab (the one with the book icon) in order to head over the wiki. Since our wiki has no content yet, there doesn't exist any page. In this case, GitHub prompts you to create the first page:

Go ahead and hit the green button.

Every time you add a new page to the wiki, the...