{"id":21096355,"url":"https://github.com/githubtraining/training-manual","last_synced_at":"2025-04-13T02:17:02.792Z","repository":{"id":37700062,"uuid":"89957504","full_name":"githubtraining/training-manual","owner":"githubtraining","description":"Home of the words in the GitHub Training Manual and teaching scripts.","archived":false,"fork":false,"pushed_at":"2024-07-29T16:36:02.000Z","size":55890,"stargazers_count":294,"open_issues_count":53,"forks_count":297,"subscribers_count":21,"default_branch":"main","last_synced_at":"2025-04-13T02:16:56.996Z","etag":null,"topics":["docsify","github-training-manuals","hacktoberfest"],"latest_commit_sha":null,"homepage":"https://githubtraining.github.io/training-manual","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/githubtraining.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-05-01T19:53:08.000Z","updated_at":"2025-04-11T14:05:55.000Z","dependencies_parsed_at":"2024-07-29T21:28:07.369Z","dependency_job_id":null,"html_url":"https://github.com/githubtraining/training-manual","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubtraining%2Ftraining-manual","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubtraining%2Ftraining-manual/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubtraining%2Ftraining-manual/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/githubtraining%2Ftraining-manual/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/githubtraining","download_url":"https://codeload.github.com/githubtraining/training-manual/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248654104,"owners_count":21140237,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docsify","github-training-manuals","hacktoberfest"],"created_at":"2024-11-19T22:35:41.658Z","updated_at":"2025-04-13T02:17:02.769Z","avatar_url":"https://github.com/githubtraining.png","language":"Shell","readme":"# GitHub Training Manual\n\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)\n\nWelcome to the GitHub Training Manual repository. In this repository, you will find the content used by the [GitHub Professional Services](https://services.github.com/) team during our official GitHub training courses and the scripts used when teaching.\n\nThe content is all written in [Markdown](https://guides.github.com/features/mastering-markdown/), and the scripts are shell scripts.\n\n## Technologies used\n\nThis manual is served using GitHub Pages and [docsify](https://docsify.js.org), and can be found at [githubtraining.github.io/training-manual](https://githubtraining.github.io/training-manual/#/).\n\n## Goals and scope\n\nThe goal of this project is to serve as a content source for training on Git and GitHub. While GitHub, select GitHub Partners, and select customers may have their own use case directly with GitHub, the content is open source so we can share and improve as a community. You can find more information on contributing in the [contributing guide](CONTRIBUTING.md).\n\nThe topic scope is limited to GitHub's core product features, on GitHub.com and also for GitHub Enterprise users.\n\n## Deploy the manual\n\nThese manuals are designed to be generated using [docsify](https://docsify.js.org). To get your own manuals up and running, all you have to do is:\n\n1. Fork this repository\n2. In your fork, click on **Settings**\n3. Scroll down to the GitHub Pages section, and set **Source:** to `main branch /docs folder`.\n4. Click **Save**.\n5. Return to the GitHub Pages section of Settings, and you'll receive the URL of your published manual.\n\n## Make changes\n\nThe official [docsify documentation](https://docsify.js.org/#/?id=docsify) is your best bet for getting up to speed with the tool.\n\nIn general, you'll find all of the manual content in the [`docs/`](docs/) folder of this repository. All content is written in Markdown, and it's all stitched together in [`docs/_sidebar.md`](docs/_sidebar.md), which specifies the order and hierarchy of the content.\n\n## Preview changes on your machine\n\nYou can install, and serve the contents of the `docs/` folder locally with minimal setup. The steps are thoroughly described in the [doscify quick start](https://docsify.js.org/#/quickstart) guide.\n\nYou can also simply run the following scripts:\n\n```shell\nscript/bootstrap\nscript/server\n```\n\n## Generate a PDF\n\nDocsify doesn't currently support creating PDFs, but you can generate one using [GitBook legacy](https://docs.gitbook.com/resources/gitbook-legacy). We've tried to make this simple for you by creating [`script/generate-pdf`](script/generate-pdf).  The legacy version of GitBook is being shut down soon, but it still works.  You'll need to follow the installation instructions below to install GitBook.  The previous installation instructions on the GitBook site have been removed.\n\n## GitBook dependency\n\n\u003c!-- textlint-disable terminology --\u003e\n\n1. Download and install [Calibre](https://calibre-ebook.com/download).\n\n1. Run Calibre once to set up the application.\n\n1. Make sure that the [Calibre command line interface](https://manual.calibre-ebook.com/generated/en/cli-index.html) is available on your path.  This is located at `/Applications/calibre.app/Contents/MacOS/` on macOS if you are running the application from the default location.\n\n\u003c!-- textlint-enable terminology --\u003e\n\n## Teaching scripts\n\nScripts that accompany the manual, and their documentation can be found in the [`script/`](script/) directory. This repository includes development container configuration. So you can run the scripts on the Visual Studio developer container or [GitHub Codespaces](https://github.com/features/codespaces).\n\n## License\n\nPlease see the [license](LICENSE) for detailed information. When using the GitHub logos, be sure to follow the [GitHub Logos and Usage](https://github.com/logos) guidelines.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithubtraining%2Ftraining-manual","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgithubtraining%2Ftraining-manual","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgithubtraining%2Ftraining-manual/lists"}