Update references to main branch on the tsdoc repo.

This commit is contained in:
Ian Clanton-Thuon 2022-04-08 19:09:12 -07:00
Родитель 6ce5d735f3
Коммит 81c3fd0148
8 изменённых файлов: 18 добавлений и 18 удалений

Просмотреть файл

@ -9,14 +9,14 @@ The TSDoc projects are developed in a single GitHub monorepo:
[https://github.com/microsoft/tsdoc](https://github.com/microsoft/tsdoc) [https://github.com/microsoft/tsdoc](https://github.com/microsoft/tsdoc)
The package folders are: The package folders are:
- [/tsdoc](https://github.com/microsoft/tsdoc/tree/master/tsdoc): the **@microsoft/tsdoc** package - [/tsdoc](https://github.com/microsoft/tsdoc/tree/main/tsdoc): the **@microsoft/tsdoc** package
- [/tsdoc-config](https://github.com/microsoft/tsdoc/tree/master/tsdoc-config): the **@microsoft/tsdoc-config** package - [/tsdoc-config](https://github.com/microsoft/tsdoc/tree/main/tsdoc-config): the **@microsoft/tsdoc-config** package
- [/eslint-plugin](https://github.com/microsoft/tsdoc/tree/master/eslint-plugin): the **eslint-plugin-tsdoc** package - [/eslint-plugin](https://github.com/microsoft/tsdoc/tree/main/eslint-plugin): the **eslint-plugin-tsdoc** package
Supplementary project folders are: Supplementary project folders are:
- [/api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo): a code sample showing how to use - [/api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo): a code sample showing how to use
the **@microsoft/tsdoc** library the **@microsoft/tsdoc** library
- [/playground](https://github.com/microsoft/tsdoc/tree/master/playground): the [TSDoc Playground](/play) web application - [/playground](https://github.com/microsoft/tsdoc/tree/main/playground): the [TSDoc Playground](/play) web application
The `tsdoc.org` website is hosted in this Github repo: The `tsdoc.org` website is hosted in this Github repo:

Просмотреть файл

@ -25,8 +25,8 @@ a particular feature will get implemented. That said, heres some feature area
future investments: future investments:
- Collect all the design specifications from the GitHub "RFC" issues and document them on the website - Collect all the design specifications from the GitHub "RFC" issues and document them on the website
- Finish integrating the [new declaration reference syntax](https://github.com/microsoft/tsdoc/tree/master/tsdoc/src/beta) - Finish integrating the [new declaration reference syntax](https://github.com/microsoft/tsdoc/tree/main/tsdoc/src/beta)
and deprecate the old syntax and deprecate the old syntax
- Expand the parser to support a much broader set of CommonMark syntax elements - Expand the parser to support a much broader set of CommonMark syntax elements
- Expand the capabilities of the [tsdoc.json](https://github.com/microsoft/tsdoc/tree/master/tsdoc-config) config file - Expand the capabilities of the [tsdoc.json](https://github.com/microsoft/tsdoc/tree/main/tsdoc-config) config file
- Write up a formal grammar specification - Write up a formal grammar specification

Просмотреть файл

@ -12,6 +12,6 @@ Even if you have not enabled a documentation tool yet for your project, adopting
👉 **To see how your comments would be rendered** by a compatible documentation tool, try pasting your `/** */` comment into the [TSDoc Playground](/play)! 👉 **To see how your comments would be rendered** by a compatible documentation tool, try pasting your `/** */` comment into the [TSDoc Playground](/play)!
👉 **Implementing a tool that needs to parse doc comments?** The [@microsoft/tsdoc](https://www.npmjs.com/package/@microsoft/tsdoc) package provides a professional quality parser. The [api-demo](https://github.com/microsoft/tsdoc/tree/master/api-demo) folder contains sample code showing how to invoke the parser. 👉 **Implementing a tool that needs to parse doc comments?** The [@microsoft/tsdoc](https://www.npmjs.com/package/@microsoft/tsdoc) package provides a professional quality parser. The [api-demo](https://github.com/microsoft/tsdoc/tree/main/api-demo) folder contains sample code showing how to invoke the parser.
👉 **Have an idea for an improvement?** We're using [GitHub issues](https://github.com/Microsoft/tsdoc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to discuss the TSDoc specification, library design, and project roadmap. 👉 **Have an idea for an improvement?** We're using [GitHub issues](https://github.com/Microsoft/tsdoc/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to discuss the TSDoc specification, library design, and project roadmap.

Просмотреть файл

@ -5,7 +5,7 @@ navigation_source: docs_nav
--- ---
[NPM package](https://www.npmjs.com/package/eslint-plugin-tsdoc)<br/> [NPM package](https://www.npmjs.com/package/eslint-plugin-tsdoc)<br/>
[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/eslint-plugin/CHANGELOG.md) [CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/eslint-plugin/CHANGELOG.md)
This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the This ESLint plugin provides a rule for validating that TypeScript doc comments conform to the
[TSDoc specification](https://github.com/microsoft/tsdoc). [TSDoc specification](https://github.com/microsoft/tsdoc).

Просмотреть файл

@ -5,7 +5,7 @@ navigation_source: docs_nav
--- ---
[NPM package](https://www.npmjs.com/package/@microsoft/tsdoc-config)<br/> [NPM package](https://www.npmjs.com/package/@microsoft/tsdoc-config)<br/>
[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/tsdoc-config/CHANGELOG.md) [CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/tsdoc-config/CHANGELOG.md)
The **@microsoft/tsdoc-config** package is an optional add-on for loading the **tsdoc.json** file format that enables The **@microsoft/tsdoc-config** package is an optional add-on for loading the **tsdoc.json** file format that enables
@ -22,7 +22,7 @@ until it finds a folder containing **tsconfig.json** or **package.json**, and th
The **tsdoc.json** file conforms to the [tsdoc.schema.json]( The **tsdoc.json** file conforms to the [tsdoc.schema.json](
https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json) JSON schema. It defines tags using
similar fields as the similar fields as the
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts) [TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/configuration/TSDocTagDefinition.ts)
API used by `TSDocParser` from **@microsoft/tsdoc**. API used by `TSDocParser` from **@microsoft/tsdoc**.
Here's a simple example: Here's a simple example:

Просмотреть файл

@ -5,7 +5,7 @@ navigation_source: docs_nav
--- ---
[NPM package](https://www.npmjs.com/package/@microsoft/tsdoc)<br/> [NPM package](https://www.npmjs.com/package/@microsoft/tsdoc)<br/>
[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/tsdoc/CHANGELOG.md) [CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/main/tsdoc/CHANGELOG.md)
The **@microsoft/tsdoc** package is the reference implementation of a parser for the TSDoc syntax. The **@microsoft/tsdoc** package is the reference implementation of a parser for the TSDoc syntax.
You cannot use it directly. It is an engine component intended to be incorporated into You cannot use it directly. It is an engine component intended to be incorporated into
@ -141,7 +141,7 @@ console.log(isApiInternal(input));
The library provides a number of other nice features: The library provides a number of other nice features:
- It tracks source code coordinates for every input token. This enables precise error messages - It tracks source code coordinates for every input token. This enables precise error messages
for every token, and can be used to implement [syntax highlighting](https://github.com/microsoft/tsdoc/blob/master/playground/src/SyntaxStyler/DocNodeSyntaxStyler.ts). for every token, and can be used to implement [syntax highlighting](https://github.com/microsoft/tsdoc/blob/main/playground/src/SyntaxStyler/DocNodeSyntaxStyler.ts).
- It provides an Abstract Syntax Tree that makes it easy - It provides an Abstract Syntax Tree that makes it easy
to [render rich text](https://github.com/microsoft/tsdoc/blob/26c4bab8efb04bc5d1619585e1f071bcc10cf16a/playground/src/DocHtmlView.tsx#L140) to [render rich text](https://github.com/microsoft/tsdoc/blob/26c4bab8efb04bc5d1619585e1f071bcc10cf16a/playground/src/DocHtmlView.tsx#L140)
@ -155,6 +155,6 @@ The library provides a number of other nice features:
## Invoking the TSDoc parser ## Invoking the TSDoc parser
The [api-demo folder](https://github.com/microsoft/tsdoc/tree/master/api-demo) provides a more complete example. The [api-demo folder](https://github.com/microsoft/tsdoc/tree/main/api-demo) provides a more complete example.
It also contains an "advanced" example, illustrating how to interface TSDoc with the parse tree returned by It also contains an "advanced" example, illustrating how to interface TSDoc with the parse tree returned by
the TypeScript compiler engine. the TypeScript compiler engine.

Просмотреть файл

@ -17,12 +17,12 @@ implementation of a parser, and many syntax details are explained in the code co
The **"old"** syntax for declaration references is detailed in this technical note: The **"old"** syntax for declaration references is detailed in this technical note:
[/spec/code-snippets/DeclarationReferences.ts](https://github.com/microsoft/tsdoc/blob/master/spec/code-snippets/DeclarationReferences.ts) [/spec/code-snippets/DeclarationReferences.ts](https://github.com/microsoft/tsdoc/blob/main/spec/code-snippets/DeclarationReferences.ts)
The **"new"** syntax for declaration references is described in this grammar: The **"new"** syntax for declaration references is described in this grammar:
[/tsdoc/src/beta/DeclarationReference.grammarkdown](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/beta/DeclarationReference.grammarkdown) [/tsdoc/src/beta/DeclarationReference.grammarkdown](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/beta/DeclarationReference.grammarkdown)
Examples of the new syntax can be found in the Examples of the new syntax can be found in the
[DeclarationReference.test.ts](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/beta/__tests__/DeclarationReference.test.ts) [DeclarationReference.test.ts](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/beta/__tests__/DeclarationReference.test.ts)
file. file.

Просмотреть файл

@ -6,7 +6,7 @@ navigation_source: docs_nav
Three "standardization groups" are used to classify the standard TSDoc tags, according to the Three "standardization groups" are used to classify the standard TSDoc tags, according to the
the level of support expected from compatible documentation tools. They correspond to the the level of support expected from compatible documentation tools. They correspond to the
[Standardization enum](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/details/Standardization.ts) [Standardization enum](https://github.com/microsoft/tsdoc/blob/main/tsdoc/src/details/Standardization.ts)
in the parser API. in the parser API.