# typedoc-plugin-graphql

> A typedoc plugin for adding highlighting for graphql code.

Latest version **1.0.3** (published 2020-09-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install typedoc-plugin-graphql
pnpm add typedoc-plugin-graphql
yarn add typedoc-plugin-graphql
bun add typedoc-plugin-graphql
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-09-21 |
| First published | 2020-09-10 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 14.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Maintainers | bennyp |
| Keywords | typedocplugin, typedoc, graphql, highlight.js |

## Links

- npm: https://www.npmjs.com/package/typedoc-plugin-graphql
- Repository: https://github.com/bennypowers/typedoc-plugin-graphql
- Issues: https://github.com/bennypowers/typedoc-plugin-graphql/issues
- npm.io page: https://npm.io/package/typedoc-plugin-graphql

## Dependencies (1)

- [highlightjs-graphql](https://npm.io/package/highlightjs-graphql.md) ^1.0

## Alternatives

- [apollo-link-http-common](https://npm.io/package/apollo-link-http-common.md) — 879.0K weekly downloads
- [react-relay](https://npm.io/package/react-relay.md) — 336.8K weekly downloads
- [relay-test-utils](https://npm.io/package/relay-test-utils.md) — 181.6K weekly downloads
- [@vendure/core](https://npm.io/package/@vendure/core.md) — 14.8K weekly downloads
- [@pnpm/deps.graph-sequencer](https://npm.io/package/@pnpm/deps.graph-sequencer.md) — 13.4K weekly downloads

## Recent versions

- 1.0.3 (latest) — 2020-09-21
- 1.0.2 — 2020-09-21
- 1.0.1 — 2020-09-10
- 1.0.0 — 2020-09-10

## README

# typedoc-plugin-graphql

> This typedoc plugin adds support for GraphQL code highlighting.

[![Package version](https://img.shields.io/npm/v/typedoc-plugin-graphql)](https://www.npmjs.com/package/typedoc-plugin-graphql)
![License](https://img.shields.io/npm/l/typedoc-plugin-graphql)

## Installation

This plugin is published as an [npm package][npm]. You can install it through npm or yarn.

```
# Using yarn
yarn add typedoc-plugin-graphql

# Using npm
npm install typedoc-plugin-graphql
```

Once installed, typedoc will automatically detect and use it.

## Example

This below example will now properly render and highlight the solidity code in the comment.

````typescript
/**
 * Queries for Blog Posts
 *
 * ```graphql
 * query BlogPostQuery {
 *   latestPosts(limit: 10) {
 *     url
 *     summary
 *     content
 *     datePosted
 *   }
 * }
 * ```
 */
@customElement('blog-posts')
class BlogPosts extends ApolloQuery<Data, Variables> {
  query = BlogPostQuery;
  // ...
}
````

## Contributing

Third party contributions to this project are welcome and encouraged. If you want to contribute, please open an issue before submtting a pull requests so we can discuss the proposed changes and/or additions.

[yarn]: https://yarnpkg.com
[node]: https://nodejs.org
[npm]: https://www.npmjs.com/package/typedoc-plugin-graphql

---
_Source: https://npm.io/package/typedoc-plugin-graphql · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._