Training Manual
Home of the words in the GitHub Training Manual and teaching scripts.
Overview:
The GitHub Training Manual repository contains content and scripts used by the GitHub Professional Services team during training courses. The content is written in Markdown, and the scripts are shell scripts. This manual serves as a resource for training on Git and GitHub, with a focus on GitHub's core product features for both GitHub.com and GitHub Enterprise users.
Features:
- Open Source Content: The content in the repository is open source, allowing for community sharing and improvement.
- Markdown Format: All content is written in Markdown for easy editing and readability.
- Deployment with docsify: The manual can be easily deployed using docsify, with steps provided for forking and setting up the repository.
- Local Preview: Users can preview changes on their local machine by serving the contents of the docs/ folder with minimal setup.
- PDF Generation: While docsify does not support PDF creation, users can generate a PDF using the provided legacy GitBook script.
- Teaching Scripts: Accompanying scripts for teaching and development can be found in the script/ directory.
- License Compliance: Guidelines for using GitHub logos and assets are provided in the license information.
- Docsify
Docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an index.html and deploy it on GitHub Pages.
