The open-source repo for docs.github.com
Перейти к файлу
Kevin Heis c451f3269e
Script to update ol/ul indents from 2 to 4 spaces (#20384)
* Script to update ol/ul indents from 2 to 4 spaces

* Update commonmark-indent.js

* Update commonmark-indent.js
2021-07-19 15:04:22 +00:00
.devcontainer updating devcontainer to use dockerfile to install correct version of node and adds some other helpful extensions for working in docs (#20059) 2021-06-23 23:23:55 +00:00
.github Update action for broken link reports to add context to and close prior reports (#20213) 2021-07-19 10:59:02 +02:00
.husky add lint-staged, pre-commit for eslint and prettier (#20368) 2021-07-15 16:41:25 +00:00
.vscode Add VS Code debugger config (#16819) 2020-12-10 18:37:06 +00:00
assets Explain why some GitHub Apps ask to "act on your behalf" (#20250) 2021-07-19 14:50:14 +00:00
components Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
content Explain why some GitHub Apps ask to "act on your behalf" (#20250) 2021-07-19 14:50:14 +00:00
contributing Merge branch 'script-to-use-short-versions' of github.com:github/docs-internal into script-to-use-short-versions 2021-06-22 13:00:01 -04:00
data Explain why some GitHub Apps ask to "act on your behalf" (#20250) 2021-07-19 14:50:14 +00:00
docs Add Observability docs to service catalog (#16878) 2020-12-12 00:04:54 +00:00
includes Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
javascripts Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
layouts Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
lib Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
middleware Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
pages Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
script Script to update ol/ul indents from 2 to 4 spaces (#20384) 2021-07-19 15:04:22 +00:00
stylesheets Pretty format (#20352) 2021-07-14 14:35:01 -07:00
tests Remove FEATURE_NEXTJS Flag Part 1 (#20176) 2021-07-16 14:54:25 -07:00
translations Sync fork with upstream (Fetch upstream) via web UI (#19806) 2021-06-21 17:49:17 +02:00
.babelrc prettier .babelrc 2021-05-07 09:04:01 -07: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
.eslintignore chore: Convert Standard to eslint-config-standard (#1328) 2020-11-17 16:18:18 -05:00
.eslintrc.js Pretty format (#20352) 2021-07-14 14:35:01 -07:00
.gitattributes Hello git history spelunker! 2020-09-27 14:10:11 +02:00
.gitignore add lint-staged, pre-commit for eslint and prettier (#20368) 2021-07-15 16:41:25 +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 Make orgs and teams content a top-level doc set (#18593) 2021-04-08 09:50:13 -05:00
.prettierignore chore: Add Prettier for Yaml formatting 2020-11-16 16:12:49 -05: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 feat: upgrade to node v16, package-lock.json v2, remove aws-sdk 2021-05-20 13:32:19 -07:00
Dockerfile Migrate CommonJS to ESM (#20301) 2021-07-14 13:49:18 -07:00
Dockerfile.openapi_decorator Add an openapi-check ci check and dockerize it (#18652) 2021-04-09 11:02:53 -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
Procfile Migrate CommonJS to ESM (#20301) 2021-07-14 13:49:18 -07:00
README.md Update README.md 2021-01-02 20:39:54 +05:30
app.json Heroku dev deps (#19431) 2021-05-24 15:40:50 -07:00
crowdin.yml move deprecated site policy content to new directory (#17270) 2021-01-14 11:41:38 -08: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 Pretty format (#20352) 2021-07-14 14:35:01 -07:00
next-env.d.ts feat: add nextjs middleware handling (#19139) 2021-05-05 15:23:46 +00:00
next.config.js Pretty format (#20352) 2021-07-14 14:35:01 -07:00
nodemon.json Fix NextJS 500s (#20048) 2021-06-22 17:30:40 +00:00
ownership.yaml Update ownership.yaml (#20392) 2021-07-16 22:16:55 +00:00
package-lock.json add lint-staged, pre-commit for eslint and prettier (#20368) 2021-07-15 16:41:25 +00:00
package.json add lint-staged, pre-commit for eslint and prettier (#20368) 2021-07-15 16:41:25 +00:00
server.mjs Pretty format (#20352) 2021-07-14 14:35:01 -07:00
tsconfig.json Update current JavaScripts to use Typescript (#19824) 2021-06-14 18:07:39 +00:00
webpack.config.js Pretty format (#20352) 2021-07-14 14:35:01 -07: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 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 pull request 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.