docs README

The project's README from github.com/github/docs. As one markdown file: README.md.

GitHub Docs

Welcome to GitHub Docs! GitHub’s documentation is open source, meaning anyone from inside or outside the company can contribute. For full contributing guidelines, visit our contributing guide.

How we sync changes across Docs repositories

There are two GitHub Docs repositories:

The two repositories sync frequently. Content changes in one are reflected in the other. Hubbers might prefer to post in docs when working with a customer, but docs has limitations on the types of contributions it accepts to safeguard the site and our workflows. Internal contributions should usually go to docs-internal.

Important: The docs repository accepts contributions to content files (.md files in /content and select /data sections like reusables only). Infrastructure files, workflows, and site-building code are not open for external modification.

New to contributing

Here are some resources to help you get started with open source contributions:

License

This project is dual-licensed under:

docs (github/docs)

Searching Database…

21K ·GitHub
这是什么?它是 docs.github.com 背后的开源仓库,也就是 GitHub 的官方文档。内容和网站代码都在这里,GitHub 内外的任何人都可以参与贡献。
这是在线文档网站本身,还是它背后的源码?两部分都在同一个仓库里:文章是 /content 目录下的 Markdown 文件(外加 reusables 之类的数据文件),由一个 TypeScript 的 Next.js 应用渲染成 docs.github.com。
我在文档里发现一个错别字,怎么把它改掉?README 会引导外部贡献者去看 CONTRIBUTING.md,里面有快速上手指南。贡献通常就是编辑 /content 目录下的某个 Markdown 文件,或 /data 下的特定部分,然后提交一个 pull request。
开发它需要特定版本的 Node 吗?需要 Node.js ^24 或 ^26,具体见 package.json 里的 engines 字段。仓库里还带一个 Dockerfile,如果你更想在容器里运行也可以;用 npm run build 即可构建网站。
网站代码我也能改吗,还是只能改文章?只能改内容:外部贡献仅限 /content 目录下的 .md 文件,以及 reusables 之类的 /data 特定部分。基础设施文件、工作流和建站代码不对外开放修改。
文档和代码用的是同一个许可证吗?不是——采用双许可证:Creative Commons Attribution 4.0 覆盖文档以及 assets、content、data 目录里的内容,代码则由 MIT License 覆盖。
这个网站是用什么搭建的?基于 Next.js 的 TypeScript——构建脚本运行的是 next build --webpack。搜索由 Elasticsearch 支持,应用还内置了 OpenTelemetry 用于遥测。
如果 GitHub 员工用的是私有仓库,改动是怎么同步到公开文档的?github/docs 是公开的那一半,github/docs-internal 是面向员工的私有仓库;两者频繁同步,一边的内容改动会反映到另一边。
我可以把 GitHub 的文档转载到自己的网站上吗?文章采用 CC-BY-4.0 许可,允许署名后复用;代码采用 MIT 许可——只要遵守这些条款,两者都可以复用。
Creator
github
Size
2.3 GB
Stars
21K
Age
7y
Commits · 90 Days