https://github.com/djdeveloperr/discord-docs-parser

Discord API Docs parser that can auto-generate API types for payloads, enums and endpoints.
https://github.com/djdeveloperr/discord-docs-parser

api deno discord docs parser types

Last synced: 10 months ago
JSON representation

Discord API Docs parser that can auto-generate API types for payloads, enums and endpoints.

• Host: GitHub
• URL: https://github.com/djdeveloperr/discord-docs-parser
• Owner: DjDeveloperr
• License: mit
• Created: 2021-01-31T06:01:12.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2021-01-31T10:02:28.000Z (about 5 years ago)
• Last Synced: 2025-02-10T11:33:41.140Z (about 1 year ago)
• Topics: api, deno, discord, docs, parser, types
• Language: TypeScript
• Homepage:
• Size: 69.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Discord Docs Parser

Parses [Discord API Docs](https://github.com/discord/discord-api/docs)' MD files to generate JSON for all the Payloads/Structures, Enumerated Values, and Endpoints.

## Usage

- Clone this repo.

- Clone [discord-api-docs](https://github.com/discord/discord-api/docs) repo to `repo` folder.

- Run `deno run --allow-read --allow-write plugins/json.ts`

  - This will generate a `docs.json`.

  - For TypeScript types, use `plugins/typescript.ts` instead.

  - You can optionally tell script the filename (in args) to write output to.

## TODO/Ideas

- Write more language plugins to create typings for various other languages.

- Look for anything missing from typings generated.

## Contributing

You're always welcome to contribute!

Please use `deno fmt` for formatting.

## License

Check [LICENSE](LICENSE) for more info.

Copyright 2021 @ DjDeveloperr