This is the web application for the git-scm.com site. It is meant to be the first place a person new to Git will land and download or learn about the Git SCM system.
This site is built with Jekyll and served via GitHub Pages.
You'll need Jekyll and the jekyll-redirect-from plugin. On Windows, we recommend using the Windows Subsystem for Linux (WSL).
You can install the jekyll-redirect-from plugin via
$ gem install --user-install jekyll-redirect-from
or by running
$ bundler install
Note: The bundler install command will install other Ruby gems, too, that are only required e.g. to update the Git version.
You can serve the site locally via
$ jekyll serve -w --incremental
The site should be running on http://127.0.0.1:4000
First, install the prerequisites:
$ bundler install --with=scripts
Then, you can build the manual pages using a local Git source clone like this:
$ GIT_REPO=../git/.git ./scripts/update-docs.rb
This will populate the man pages for all Git versions. You can also populate them only for a specific Git version (faster):
$ version=v2.23.0
$ GIT_REPO=../git/.git REBUILD_DOC=$version rake local_index
Or you can populate the man pages from GitHub (much slower) like this:
$ export GITHUB_API_TOKEN=github_personal_auth_token
$ rake preindex # all versions
$ REBUILD_DOC=$version rake preindex # specific version
Similarly, you can also populate the localized man pages. From a local clone of https://github.com/jnavila/git-html-l10n :
$ GIT_REPO=../git-html-l10n/.git rake local_index_l10n # all versions
$ GIT_REPO=../git-html-l10n/.git REBUILD_DOC=$version rake local_index_l10n # specific version
Or you can do it from GitHub (much slower) like this:
$ export GITHUB_API_TOKEN=github_personal_auth_token
$ rake preindex_l10n # all versions
$ REBUILD_DOC=$version rake preindex_l10n # specific version
Now you need to get the latest downloads for the downloads pages:
$ script/update-download-data.rb
First, you will have to get the necessary prerequisites:
$ bundler install --with=scripts
Now you'll probably want some book data. You'll have to have access to the Pro Git project on GitHub through the API.
$ export GITHUB_API_TOKEN=github_personal_auth_token
$ script/update-book2.rb en
If you have 2FA enabled, you'll need to create a Personal Access Token.
That will generate the book content from the Asciidoc files fetched from the online repository and write the files to the local tree, ready to be committed and served via Jekyll. If you want to build the book for all available languages, just skip the language code:
$ script/update-book2.rb
Alternatively, you can get the book content from a repository on your computer by specifying the path:
$ script/update-book2.rb fr ../progit2-fr
If you wish to contribute to this website, please fork it on GitHub, push your change to a named branch, then send a pull request. If it is a big feature, you might want to start an issue first to make sure it's something that will be accepted. If it involves code, please also write tests for it.
The list of GUI clients has been constructed by the community for a long time. If you want to add another tool you'll need to follow a few steps:
-
Add a new
.mdfile with the GUI client details: https://github.com/git/git-scm.com/tree/main/\_guis- The fields need to be enclosed within
---lines - The fields
name,project_url,price,licenseshould be very straightforward to fill. - The field
image_tagcorresponds to the path of the image of the tool (should start withimages/guis/). platformsis a list of at least 1 platform in which the tool is supported. The possibilities are:Windows,Mac,Linux,Android, andiOSordercan be filled with the biggest number already existing, plus 1 (Adding to the bottom - this will be covered in the following steps). This is the only field whose value should not be enclosed in double-quote characters.trend_nameis an optional field that can be used for helping sorting the clients (also covered in the next steps)
- The fields need to be enclosed within
-
Add the image to
images/guis/<GUI_CLIENT_NAME>@2x.pngandpublic/images/guis/<GUI_CLIENT_NAME>.pngmaking sure the aspect ratio matches a 588:332 image.
- https://jekyllrb.com/docs/
- https://shopify.github.io/liquid/
- https://github.com/jekyll/jekyll-redirect-from
- https://github.com/jekyll/github-metadata/blob/main/docs/site.github.md
- https://lunrjs.com/guides/index_prebuilding.html
The source code for the site is licensed under the MIT license, which you can find in the MIT-LICENSE.txt file.
All graphical assets are licensed under the Creative Commons Attribution 3.0 Unported License.