This commit is contained in:
Pete Gonzalez 2020-11-27 18:41:39 -08:00
Родитель 3a83d7dc0f
Коммит 07bf341346
6 изменённых файлов: 36 добавлений и 10 удалений

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

@ -49,7 +49,7 @@ Implementation:
- [Pete Gonzalez](https://github.com/octogonz) created the initial concept and parser API
- [Ron Buckton](https://github.com/rbuckton) redesigned the declaration reference syntax and has been working on a rewrite of the markdown parser
- [Ian Clanton-Thuon](https://github.com/iclanton/) contributed the TSDoc Playground
- [Brian Folts](https://github.com/bafolts) contributed `eslint-plugin-tsdoc` package for ESLint
- [Brian Folts](https://github.com/bafolts) contributed **eslint-plugin-tsdoc** package for ESLint
- many other contributors who implemented features and bugfixes!
(Should your name appear here? [Suggest an update](https://github.com/microsoft/tsdoc.org-website/edit/master/_includes/home_content.md) to this page.)

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

@ -34,7 +34,7 @@ This ESLint plugin provides a rule for validating that TypeScript doc comments c
}
```
2. Add the `eslint-plugin-tsdoc` dependency to your project:
2. Add the **eslint-plugin-tsdoc** dependency to your project:
```bash
$ cd my-project

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

@ -8,7 +8,7 @@ navigation_source: docs_nav
[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/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
users to define custom TSDoc tags. (This functionality was moved to its own package because it requires external
dependencies such as NodeJS and `ajv`, whereas the main package is fully self-contained.)
@ -23,7 +23,7 @@ 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
similar fields as the
[TSDocTagDefinition](https://github.com/microsoft/tsdoc/blob/master/tsdoc/src/configuration/TSDocTagDefinition.ts)
API used by `TSDocParser` from `@microsoft/tsdoc`.
API used by `TSDocParser` from **@microsoft/tsdoc**.
Here's a simple example:
@ -60,7 +60,7 @@ a list of paths that will be mixed in with the current file:
## API Usage
The code sample below illustrates how to invoke the `@microsoft/tsdoc-config` API to load a
The code sample below illustrates how to invoke the **@microsoft/tsdoc-config** API to load a
**tsdoc.json** file:
```ts

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

@ -7,12 +7,12 @@ navigation_source: docs_nav
[NPM package](https://www.npmjs.com/package/@microsoft/tsdoc)<br/>
[CHANGELOG.md](https://github.com/microsoft/tsdoc/blob/master/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
[other documentation tools]({% link pages/intro/using_tsdoc.md %}).
If you are implementing a tool that needs to extract information from TypeScript code comments,
`@microsoft/tsdoc` provides an easy solution that will correctly implement TSDoc.
**@microsoft/tsdoc** provides an easy solution that will correctly implement TSDoc.
## Can't I just use a RegExp?
@ -99,7 +99,7 @@ This leads to a couple insights:
## Invoking the TSDoc parser
Here's how we might implement `isApiInternal()` using the `@microsoft/tsdoc` engine:
Here's how we might implement `isApiInternal()` using the **@microsoft/tsdoc** engine:
```ts
import { TSDocParser, ParserContext } from '@microsoft/tsdoc';

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

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

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

@ -4,4 +4,14 @@ title: Getting help
navigation_source: docs_nav
---
DOCS GO HERE
The TSDoc projects are coordinated by the [Rush Stack](https://rushstack.io/) group at Microsoft.
Although Microsoft does not provide official support for TSDoc, there are community options for help:
- **Found a bug?** Create a [GitHub issue](https://github.com/microsoft/tsdoc/issues)
- **Problem with the website?** Create your issue under
the [tsdoc.org-website](https://github.com/microsoft/tsdoc.org-website/issues) GitHub project
- **Zulip chat:** The Rush Stack chat server hosts a [#tsdoc](https://rushstack.zulipchat.com/#narrow/stream/266672-tsdoc)
stream where you can contact the project maintainers.