5d080b74e0
* search improvements * expose search result score on debug=1 qs (#22452) * Search index improvements (#22428) * concatenate headings for search ranking (#22445) * search index improvements * update index * add data-search property used to create search records * direct match title and normalize results to one per article * the search index is getting huge * add chinese lang, intro, and boost * create a article level record with no heading for each article * remove chinese language and exact match, boost breadcrumbs * break out debug mode into separate branch * break adding chinese out into another branch * one record per article remove limits * revert added spaces * revert adding property on article page * concatenate headings for search ranking * remove slug property, fix test * update record format in tests * revert adding this property back * scrape article-body not contents * adding heading property to tests * add headings to content property * Update script/search/parse-page-sections-into-records.js Co-authored-by: Peter Bengtsson <peterbe@github.com> * Update script/search/parse-page-sections-into-records.js Co-authored-by: Peter Bengtsson <peterbe@github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com> * search by popularity (#22496) * search by popularity * adjust factors based on length of query and normalize Lunr score * Apply suggestions from code review Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> * turn html into text with appropriate spaces (#22528) * turn HTML into text with appropriate spaces Part of #1141 * fix unit test * improve tests * small refactor * slice the search results .content (#22514) * search by popularity * adjust factors based on length of query and normalize Lunr score * slice the search result .content Part of #1142 * Update lib/search/lunr-search.js Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> * truncate translated search index records (#22475) * truncate translated search index records * page entire page object * revert search indexes * try reverting search indexes again... * out of sync with main in parent branch so reverting last commit again * rever deleted indexes * remove debug lines * correct package-lock.json * slice content string better (#22586) Part of #1149 * include home pages in the search (#22568) * Search remove hyphen as token (#22584) * slice better when not present in content (#22672) * fix missing search breadcrumbs (#22681) * fix missing search breadcrumbs * hopefully fix tests Co-authored-by: Peter Bengtsson <mail@peterbe.com> * Highlight based on combined matchData (#22692) * highlight based on combined matchData * refactoring * remove results when lang or version changes (#22697) * search with AND on title first and favor that more * commented out code * Update lib/search/lunr-search.js * only apply the wildcard to the title search if the last word is short Co-authored-by: Rachael Sewell <rachmari@github.com>
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 PR(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. By this way you can also be a part of Open source contributor's community without even writing a single line of code.
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: YOu can go through among them for specified details regarding the topics listed below.
- content/README.md
- content/graphql/README.md
- content/rest/README.md
- contributing/README.md
- data/README.md
- data/reusables/README.md
- data/variables/README.md
- includes/liquid-tags/README.md
- includes/README.md
- components/README.md
- lib/liquid-tags/README.md
- middleware/README.md
- script/README.md
- stylesheets/README.md
- tests/README.md
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 you are 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 ✨ !