The open-source repo for docs.github.com
Перейти к файлу
James M. Greene fc917569b4 Add script to symlink to local early-access repo 2020-11-11 00:58:16 -06:00
.github Don't re-run build for Actions in the internal repo 2020-11-10 16:01:18 -06:00
.vscode Hello git history spelunker! 2020-09-27 14:10:11 +02:00
assets Migrating from Travis to GitHub Actions (#16322) 2020-11-06 18:07:41 +10:00
content Remove old '/early-access' redirect from API Previews page 2020-11-10 14:36:34 -06:00
contributing Merge branch 'main' into patch-1 2020-11-06 12:46:33 -07:00
data Merge branch 'main' into hidden-docs-alt 2020-11-09 13:09:52 -06:00
docs Hello git history spelunker! 2020-09-27 14:10:11 +02:00
includes Merge branch 'main' into hidden-docs-alt 2020-11-09 13:09:52 -06:00
javascripts Support GHAE in Algolia (#16315) 2020-11-03 15:35:56 -05:00
layouts Actions landing page top bits (#16266) 2020-11-03 13:23:50 -05:00
lib Add early-access back in as a product 2020-11-10 14:37:03 -06:00
middleware EA context middleware cleanup 2020-11-11 00:30:40 -06:00
script Add script to symlink to local early-access repo 2020-11-11 00:58:16 -06:00
stylesheets Add copy button to code blocks (#16052) 2020-10-16 10:55:35 -04:00
tests Make Early Access tests only run on the docs-internal repo 2020-11-10 15:25:18 -06:00
translations Remove old '/early-access' redirect from API Previews page 2020-11-10 14:36:34 -06:00
.editorconfig chore: Add EditorConfig for IDE whitespace 2020-11-03 10:59:19 -05:00
.env.example Mostly reverting github/docs-internal#15313 2020-11-09 13:07:04 -06:00
.gitattributes Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.gitignore Add script to symlink to local early-access repo 2020-11-11 00:58:16 -06:00
.node-version Upgrade to Node.js 14 (#15822) 2020-10-05 17:02:55 -07:00
.npmrc Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.pa11yci Hello git history spelunker! 2020-09-27 14:10:11 +02:00
CODE_OF_CONDUCT.md Hello git history spelunker! 2020-09-27 14:10:11 +02:00
CONTRIBUTING.md typo: continously -> continuously 2020-11-04 14:38:42 -05:00
Dockerfile Upgrade to Node.js 14 (#15822) 2020-10-05 17:02:55 -07:00
Gemfile Hello git history spelunker! 2020-09-27 14:10:11 +02:00
Gemfile.lock Hello git history spelunker! 2020-09-27 14:10:11 +02:00
LICENSE Reorg LICENSE files to be more discoverable (#204) 2020-10-07 15:11:49 -07:00
LICENSE-CODE Reorg LICENSE files to be more discoverable (#204) 2020-10-07 15:11:49 -07:00
Procfile Hello git history spelunker! 2020-09-27 14:10:11 +02:00
README.md chore: Trim trailing whitespace 2020-11-04 10:47:43 -05:00
app.json Hello git history spelunker! 2020-09-27 14:10:11 +02:00
crowdin.yml Be consistent about paths in CrowdIn config 2020-11-09 23:15:51 -06:00
ea-config.yml set staging branch back to main 2020-10-26 09:51:54 -04:00
feature-flags.json Remove versions feature flag code (#15793) 2020-09-29 13:36:07 -04:00
jest-puppeteer.config.js Hello git history spelunker! 2020-09-27 14:10:11 +02:00
jest.config.js Hello git history spelunker! 2020-09-27 14:10:11 +02:00
nodemon.json Hello git history spelunker! 2020-09-27 14:10:11 +02:00
ownership.yaml Hello git history spelunker! 2020-09-27 14:10:11 +02:00
package-lock.json Merge branch 'main' into hidden-docs-alt 2020-11-09 13:09:52 -06:00
package.json Rename clone-early-access script 2020-11-10 16:01:35 -06:00
server.js Prevent warmserver from blocking the port from being attached (#16150) 2020-10-21 10:26:50 -04:00
webpack.config.js Add analyticsTags to Algolia search queries (#15719) 2020-09-30 18:31:04 +02:00

README.md

GitHub Docs

This repository contains the documentation website code and Markdown source files for docs.github.com.

GitHub's Docs team works on pre-production content in a private repo that regularly syncs with this public repo.

In this article:

Contributing

Start contributing right now:

We accept a lot of different contributions, including some that don't require you to write a single line of code.

Click make a contribution from docs

As you're using the GitHub Docs, you may find something in an article that you'd like to add to, update, or change. Click on make a contribution to navigate directly to that article in the codebase, so that you can begin making your contribution.

Open an issue

If you've found a problem, you can open an issue using a template.

Solve an issue

If you have a solution to one of the open issues, you will need to fork the repository and submit a PR using the template that is visible automatically in the pull request body. For more details about this process, please check out Getting Started with Contributing.

Join us in discussions

We use GitHub Discussions to talk about all sorts of topics related to documentation and this site. For example: if you'd like help troubleshooting a PR, have a great new idea, or want to share something amazing you've learned in our docs, join us in discussions.

And that's it!

That's how you can get started easily as a member of the GitHub Documentation community.

If you want to know more, or you're making a more complex contribution, check out Getting Started with Contributing.

There are a few more things to know when you're getting started with this repo:

  1. If you're having trouble with your GitHub account, contact Support.
  2. We do not accept pull requests for translated content - see CONTRIBUTING.md for more information.

READMEs

In addition to the README you're reading right now, this repo includes other READMEs that describe the purpose of each subdirectory in more detail:

License

The GitHub product documentation in the assets, content, and data folders are licensed under a CC-BY license.

All other code in this repository is licensed under a MIT license.

When using the GitHub logos, be sure to follow the GitHub logo guidelines.