https://github.com/jbl428/type-graphql-to-md

Make markdown for type graphql spec
https://github.com/jbl428/type-graphql-to-md

markdown typegraphql

Last synced: about 1 month ago
JSON representation

Make markdown for type graphql spec

• Host: GitHub
• URL: https://github.com/jbl428/type-graphql-to-md
• Owner: jbl428
• License: mit
• Created: 2020-09-21T12:07:09.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2021-06-23T21:44:02.000Z (almost 4 years ago)
• Last Synced: 2025-03-18T15:31:35.728Z (about 1 month ago)
• Topics: markdown, typegraphql
• Language: TypeScript
• Homepage:
• Size: 425 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# type-graphql-to-md

[![npm version](https://badge.fury.io/js/type-graphql-to-md.svg)](https://badge.fury.io/js/type-graphql-to-md)

![action workflow](https://github.com/jbl428/type-graphql-to-md/actions/workflows/node.yml/badge.svg)

Make a markdown file for type-graphql spec

## Requirement

- TypeGraphQL

## Example

Refer `src/markdown.spec.ts`

```typescript

import { buildSchema } from 'type-graphql';

// you should call buildSchema function from type-graphql first

await buildSchema({ resolvers: [SampleResolver], });

await exportToMarkdown('API Spec', 'spec.md');

```

## Test

```sh

yarn test

```