Learn about writing for GitHub Docs.
Writing content to be translatedOur documentation is translated into multiple languages. How we approach writing the English language documentation can greatly improve the quality of those translations.
Versioning documentationGitHub Docs uses YAML frontmatter and liquid operators to support multiple versions of GitHub with a single-source approach.
Using YAML frontmatterYou can use YAML frontmatter to define versioning, add metadata, and control the layout for articles.
Creating screenshotsYou can help users locate elements of the user interface that are difficult to find by adding screenshots to GitHub Docs.
Configuring redirectsIf an article's title, version, or location changes, you can create a redirect to the current content.
Annotating code examplesYou can annotate longer code examples to explain how they work and how people can customize them for other uses.
TemplatesThis article contains starter templates for the different content types used in GitHub Docs.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4