The open-source repo for docs.github.com
Перейти к файлу
GitHub Actions a952b20d66 update search indexes 2022-03-21 10:02:52 +00:00
.devcontainer Change publisher of open-reusables extension 2022-03-18 09:23:08 +00:00
.github don't need disk caching for site data (#26333) 2022-03-19 16:05:27 +00:00
.husky Allow git operations when LFS isn't functioning (#20569) 2021-07-28 21:35:43 +00:00
.vscode Fix the workspace settings.json 2022-01-12 14:46:27 +00:00
assets/images Updating docs for new renderable in markdown and mermaid file support (#26204) 2022-03-17 17:42:37 +00:00
components Merge branch 'main' into pwsh-commands 2022-03-18 09:23:02 +10:00
content Clarify that web and api request redirect to configured hostname in GHES (#26217) 2022-03-21 16:30:18 +10:00
contributing Merge branch 'main' into pwsh-commands 2022-03-10 16:03:39 +10:00
data Add release note for encrypted SAML assertions in GitHub Enterprise Server 3.4.0 (#26312) 2022-03-21 09:50:53 +00:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes remove rest include file (#25802) 2022-03-03 21:17:35 +00:00
lib update search indexes 2022-03-21 10:02:52 +00:00
middleware do rendering end-to-end tests with a real server (#26169) 2022-03-18 17:06:12 -04:00
pages Update 404.tsx 2022-03-14 08:31:43 -07:00
script don't need disk caching for site data (#26333) 2022-03-19 16:05:27 +00:00
stylesheets Move mini tocs rest + collapsible (#26069) 2022-03-14 10:50:53 -07:00
tests automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
translations New translation batch for es (#26354) 2022-03-20 18:08:06 +00:00
.babelrc fix: filter hidden pages from the currentProductTree (SidebarProduct) (#20404) 2021-07-20 12:32:35 -04:00
.dockerignore Public Repo Azure Preview Environments (#25206) 2022-02-10 14:14:40 -06:00
.editorconfig chore: Add EditorConfig for IDE whitespace 2020-11-03 10:59:19 -05:00
.env.example Removing algolia (#20633) 2021-08-05 13:10:51 -04:00
.eslintrc.js eslint check the .github/actions-scripts/* files too (#23698) 2021-12-15 17:35:34 +00:00
.gitattributes LFS the Lunr Indexes (#20521) 2021-07-27 22:06:31 +00:00
.gitignore .redirects-cache_en_ja.json should not be checked in (#25537) 2022-02-22 18:22:59 +00:00
.node-version feat: upgrade to node v16, package-lock.json v2, remove aws-sdk 2021-05-20 13:32:19 -07:00
.npmrc Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.pa11yci Changed title, links, updated intro and first section (#25875) 2022-03-12 01:47:15 +00:00
.prettierignore run prettier on all code in CI (#23482) 2021-12-08 16:11:52 +00:00
.prettierrc.json Pretty format (#20352) 2021-07-14 14:35:01 -07:00
CODE_OF_CONDUCT.md Add restriction on private contact of community members without permission (#16570) 2020-11-23 11:27:30 -07:00
CONTRIBUTING.md Update CONTRIBUTING.md (#22398) 2021-10-25 17:43:56 +00:00
Dockerfile automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
Dockerfile.openapi_decorator add `data` directory (#22529) 2021-11-02 07:35:03 -07: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
README.md Test prebuild regeneration 2022-02-09 09:37:04 +00:00
azure-preview-env-template.json Add persistent caddy storage (#25242) 2022-02-10 16:42:24 -06:00
crowdin.yml cope with possible translation drift (#24842) 2022-02-04 14:31:56 +00:00
docker-compose.prod.tmpl.yaml feat: add slow down middleware (#26207) 2022-03-15 13:31:12 -05:00
docker-compose.yaml Accept glob patterns for source files in openapi-check script (#18965) 2021-04-26 21:56:12 +00:00
feature-flags.json Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
jest-puppeteer.config.js Pretty format (#20352) 2021-07-14 14:35:01 -07:00
jest.config.js automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
jest.setup.js Fail on console.error in tests with failOnConsole (#25600) 2022-02-25 10:49:27 -06:00
next-env.d.ts Revert back to using Next.js v11 (#24199) 2022-01-11 20:37:24 +00:00
next.config.js remove 'de' as a possible NextJS redirect language (#26315) 2022-03-18 19:19:36 +00:00
nodemon.json Create a storybook with callout component (#20902) 2021-08-17 20:28:59 +00:00
ownership.yaml Update ownership.yaml (#25551) 2022-02-23 16:23:00 -08:00
package-lock.json automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
package.json automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
server.mjs automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
start-server.mjs automatically start server for jest (#26206) 2022-03-18 21:46:07 +00:00
tsconfig.json Refactor display-platform-specific-content (#22665) 2021-11-12 14:40:35 +00: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.

Use the table of contents icon on the top left corner of this document to get to a specific section of this guide quickly.

Contributing

See the contributing guide for detailed instructions on how to get started with our project.

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

On the GitHub Docs site, you can click the make a contribution button to open a pull request for quick fixes like typos, updates, or link fixes.

For more complex contributions, you can open an issue using the most appropriate issue template to describe the changes you'd like to see.

If you're looking for a way to contribute, you can scan through our existing issues for something to work on. When ready, check out Getting Started with Contributing for detailed instructions.

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 the discussions.

And that's it!

If you're having trouble with your GitHub account, contact Support.

That's how you can easily become a member of the GitHub Documentation community.

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 the MIT license.

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

Thanks 💜

Thanks for all your contributions and efforts towards improving the GitHub documentation. We thank you being part of our community !