зеркало из https://github.com/github/docs.git
Update github/linguist references to point to the new location at github-linguist/linguist (#36485)
This commit is contained in:
Родитель
7ddd7d2940
Коммит
e9958bf5bb
|
@ -92,7 +92,7 @@ This procedure demonstrates how to create a starter workflow and metadata file.
|
|||
* An icon from {% data variables.product.prodname_dotcom %}'s set of [Octicons](https://primer.style/octicons/). To reference an octicon, the value must be `octicon <icon name>`. For example, `octicon smiley`.
|
||||
* `categories` - **Optional.** Defines the categories that the workflow is shown under. You can use category names from the following lists:
|
||||
* General category names from the [starter-workflows](https://github.com/actions/starter-workflows/blob/main/README.md#categories) repository.
|
||||
* Linguist languages from the list in the [linguist](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) repository.
|
||||
* Linguist languages from the list in the [linguist](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml) repository.
|
||||
* Supported tech stacks from the list in the [starter-workflows](https://github.com/github-starter-workflows/repo-analysis-partner/blob/main/tech_stacks.yml) repository.
|
||||
|
||||
* `filePatterns` - **Optional.** Allows the workflow to be used if the user's repository has a file in its root directory that matches a defined regular expression.
|
||||
|
|
|
@ -14,7 +14,7 @@ shortTitle: Add a license to a repo
|
|||
---
|
||||
If you include a detectable license in your repository, people who visit your repository will see it at the top of the repository page. To read the entire license file, click the license name.
|
||||
|
||||
![Screenshot of the main page of the github/linguist repository. In the right sidebar, "MIT license," preceded by a law icon, is outlined in dark orange.](/assets/images/help/repository/repo-license-indicator.png)
|
||||
![Screenshot of the main page of the github-linguist/linguist repository. In the right sidebar, "MIT license," preceded by a law icon, is outlined in dark orange.](/assets/images/help/repository/repo-license-indicator.png)
|
||||
|
||||
Open source licenses enable others to freely use, change, and distribute the project in your repository. For more information on repository licenses, see "[AUTOTITLE](/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository)."
|
||||
|
||||
|
|
|
@ -123,7 +123,7 @@ You can use a `textarea` element to add a multi-line text field to your form. Co
|
|||
| `description` | A description of the text area to provide context or guidance, which is displayed in the form. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
||||
| `placeholder` | A semi-opaque placeholder that renders in the text area when empty. | {% octicon "x" aria-label="Optional" %} | String | Empty String | {% octicon "dash" aria-label="Not applicable" %} |
|
||||
| `value` | Text that is pre-filled in the text area. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | {% octicon "dash" aria-label="Not applicable" %} |
|
||||
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml). |
|
||||
| `render` | If a value is provided, submitted text will be formatted into a codeblock. When this key is provided, the text area will not expand for file attachments or Markdown editing. | {% octicon "x" aria-label="Optional" %} | String | {% octicon "dash" aria-label="Not applicable" %} | Languages known to {% data variables.product.prodname_dotcom %}. For more information, see [the languages YAML file](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml). |
|
||||
|
||||
#### Validations for `textarea`
|
||||
|
||||
|
|
|
@ -38,7 +38,7 @@ Within conversations on {% data variables.product.product_name %}, references to
|
|||
| `#` and issue or pull request number | #26 | [#26](https://github.com/jlord/sheetsee.js/issues/26) |
|
||||
| `GH-` and issue or pull request number | GH-26 | [GH-26](https://github.com/jlord/sheetsee.js/issues/26) |
|
||||
| `Username/Repository#` and issue or pull request number | jlord/sheetsee.js#26 | [jlord/sheetsee.js#26](https://github.com/jlord/sheetsee.js/issues/26)
|
||||
| `Organization_name/Repository#` and issue or pull request number | github/linguist#4039 | [github/linguist#4039](https://github.com/github/linguist/pull/4039)
|
||||
| `Organization_name/Repository#` and issue or pull request number | github-linguist/linguist#4039 | [github-linguist/linguist#4039](https://github.com/github-linguist/linguist/pull/4039)
|
||||
|
||||
{% ifversion fpt or ghec %}
|
||||
If you reference an issue, pull request, or discussion in a list, the reference will unfurl to show the title and state instead. For more information about task lists, see "[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists)."
|
||||
|
|
|
@ -67,7 +67,7 @@ This will display the code block with syntax highlighting:
|
|||
|
||||
![Screenshot of three lines of Ruby code as displayed on {% data variables.product.prodname_dotcom %}. Elements of the code display in purple, blue, and red type, making the lines more visually scannable.](/assets/images/help/writing/code-block-syntax-highlighting-rendered.png)
|
||||
|
||||
We use [Linguist](https://github.com/github/linguist) to perform language detection and to select [third-party grammars](https://github.com/github/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||
We use [Linguist](https://github.com/github-linguist/linguist) to perform language detection and to select [third-party grammars](https://github.com/github-linguist/linguist/blob/master/vendor/README.md) for syntax highlighting. You can find out which keywords are valid in [the languages YAML file](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml).
|
||||
|
||||
{% ifversion mermaid %}
|
||||
## Creating diagrams
|
||||
|
|
|
@ -53,7 +53,7 @@ You can compare your base repository and any forked repository. This is the view
|
|||
|
||||
To compare branches on different repositories, preface the branch names with user names. For example, by specifying `octocat:main` for `base` and `octo-org:main` for `compare`, you can compare the `main` branch of the repositories respectively owned by `octocat` and `octo-org`.
|
||||
|
||||
Here's an example of a [comparison between two repositories](https://github.com/github/linguist/compare/master...octocat:master).
|
||||
Here's an example of a [comparison between two repositories](https://github.com/github-linguist/linguist/compare/master...octocat:master).
|
||||
|
||||
## Comparisons across commits
|
||||
|
||||
|
|
|
@ -31,7 +31,7 @@ title: "My Research Software"
|
|||
version: 2.0.4
|
||||
doi: 10.5281/zenodo.1234
|
||||
date-released: 2017-12-18
|
||||
url: "https://github.com/github/linguist"
|
||||
url: "https://github.com/github-linguist/linguist"
|
||||
```
|
||||
|
||||
The GitHub citation prompt on your repository will show the example `CITATION.cff` content in these formats:
|
||||
|
@ -51,7 +51,7 @@ Lisa, M., & Bot, H. (2017). My Research Software (Version 2.0.4) [Computer softw
|
|||
doi = {10.5281/zenodo.1234},
|
||||
month = {12},
|
||||
title = {{My Research Software}},
|
||||
url = {https://github.com/github/linguist},
|
||||
url = {https://github.com/github-linguist/linguist},
|
||||
version = {2.0.4},
|
||||
year = {2017}
|
||||
}
|
||||
|
@ -108,7 +108,7 @@ title: "My Research Software"
|
|||
version: 2.0.4
|
||||
doi: 10.5281/zenodo.1234
|
||||
date-released: 2017-12-18
|
||||
url: "https://github.com/github/linguist"
|
||||
url: "https://github.com/github-linguist/linguist"
|
||||
preferred-citation:
|
||||
type: article
|
||||
authors:
|
||||
|
|
|
@ -19,10 +19,10 @@ topics:
|
|||
- Repositories
|
||||
shortTitle: Repository languages
|
||||
---
|
||||
{% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github/linguist) to
|
||||
{% data variables.product.product_name %} uses the open source [Linguist library](https://github.com/github-linguist/linguist) to
|
||||
determine file languages for syntax highlighting and repository statistics. Language statistics will update after you push changes to your default branch.
|
||||
|
||||
Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github/linguist/blob/master/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files.
|
||||
Some files are hard to identify, and sometimes projects contain more library and vendor files than their primary code. If you're receiving incorrect results, please consult the Linguist [troubleshooting guide](https://github.com/github-linguist/linguist/blob/master/docs/troubleshooting.md) for help. Note that Linguist only works for repositories with fewer than 100,000 files.
|
||||
|
||||
## Markup languages
|
||||
|
||||
|
|
|
@ -26,5 +26,5 @@ search/index.json linguist-generated=true
|
|||
```
|
||||
|
||||
## Further reading
|
||||
- "[Generated code](https://github.com/github/linguist/blob/master/docs/overrides.md#generated-code)" in the Linguist documentation
|
||||
- "[Generated code](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md#generated-code)" in the Linguist documentation
|
||||
- "[AUTOTITLE](/repositories/working-with-files/managing-files/creating-new-files)"
|
||||
|
|
|
@ -653,7 +653,7 @@ These timestamps look something like `2014-02-27T15:05:06+01:00`. Also see [this
|
|||
It is possible to supply a `Time-Zone` header which defines a timezone according to the [list of names from the Olson database](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones).
|
||||
|
||||
```shell
|
||||
$ curl -H "Time-Zone: Europe/Amsterdam" -X POST {% data variables.product.api_url_pre %}/repos/github/linguist/contents/new_file.md
|
||||
$ curl -H "Time-Zone: Europe/Amsterdam" -X POST {% data variables.product.api_url_pre %}/repos/github-linguist/linguist/contents/new_file.md
|
||||
```
|
||||
|
||||
This means that we generate a timestamp for the moment your API call is made in the timezone this header defines. For example, the API to manage contents generates a git commit for each addition or change and uses the current time as the timestamp. For more information, see "[AUTOTITLE](/rest/repos#contents)." This header will determine the timezone used for generating that current timestamp.
|
||||
|
|
|
@ -110,13 +110,13 @@ You can use specialized keywords to qualify your search.
|
|||
To search within a repository, use the `repo:` qualifier. You must provide the full repository name, including the owner. For example:
|
||||
|
||||
```
|
||||
repo:github/linguist
|
||||
repo:github-linguist/linguist
|
||||
```
|
||||
|
||||
To search within a set of repositories, you can combine multiple `repo:` qualifiers with the boolean operator `OR`. For example:
|
||||
|
||||
```
|
||||
repo:github/linguist OR repo:tree-sitter/tree-sitter
|
||||
repo:github-linguist/linguist OR repo:tree-sitter/tree-sitter
|
||||
```
|
||||
|
||||
{% note %}
|
||||
|
@ -154,7 +154,7 @@ To narrow down to a specific languages, use the `language:` qualifier. For examp
|
|||
language: ruby OR language:cpp OR language:csharp
|
||||
```
|
||||
|
||||
For a complete list of supported language names, see [languages.yaml](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml) in [github/linguist](https://github.com/github/linguist). If your preferred language is not on the list, you can open a pull request to add it.
|
||||
For a complete list of supported language names, see [languages.yaml](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml) in [github-linguist/linguist](https://github.com/github-linguist/linguist). If your preferred language is not on the list, you can open a pull request to add it.
|
||||
|
||||
### Path qualifier
|
||||
|
||||
|
|
|
@ -49,7 +49,7 @@ By default, file finder results do not include files in the following directorie
|
|||
|
||||
You can override these default exclusions using a `.gitattributes` file.
|
||||
|
||||
To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github/linguist/blob/master/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results.
|
||||
To do this, create or update a file called `.gitattributes` in your repository root, setting the [`linguist-generated`](https://github.com/github-linguist/linguist/blob/master/docs/overrides.md) attribute to `false` for each directory that should be included in file finder results.
|
||||
|
||||
For example, the following `.gitattributes` file would cause files in the `build/` directory to be available to the file finder:
|
||||
|
||||
|
|
|
@ -79,7 +79,7 @@ You can use the `path` qualifier to search for source code that appears at a spe
|
|||
|
||||
## Search by language
|
||||
|
||||
You can search for code based on what language it's written in. The `language` qualifier can be the language name or alias. For a full list of supported languages with their names and aliases, see the [github/linguist repository](https://github.com/github/linguist/blob/master/lib/linguist/languages.yml).
|
||||
You can search for code based on what language it's written in. The `language` qualifier can be the language name or alias. For a full list of supported languages with their names and aliases, see the [github-linguist/linguist repository](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml).
|
||||
|
||||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
|
|
|
@ -194,7 +194,7 @@ You can use the `project` qualifier to find issues that are associated with a sp
|
|||
| Qualifier | Example
|
||||
| ------------- | -------------
|
||||
| <code>project:<em>PROJECT_BOARD</em></code> | **project:github/57** matches issues owned by GitHub that are associated with the organization's project board 57.
|
||||
| <code>project:<em>REPOSITORY/PROJECT_BOARD</em></code> | **project:github/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository.
|
||||
| <code>project:<em>REPOSITORY/PROJECT_BOARD</em></code> | **project:github-linguist/linguist/1** matches issues that are associated with project board 1 in @github's linguist repository.
|
||||
|
||||
## Search by commit status
|
||||
|
||||
|
|
|
@ -1 +1 @@
|
|||
For example, this URL uses the shortened seven-character SHA codes to compare commits `c3a414e` and `faf7c6f`: `https://github.com/github/linguist/compare/c3a414e..faf7c6f`.
|
||||
For example, this URL uses the shortened seven-character SHA codes to compare commits `f75c570` and `3391dcc`: `https://github.com/github-linguist/linguist/compare/f75c570..3391dcc`.
|
||||
|
|
Загрузка…
Ссылка в новой задаче