Skip to content

Allows for embedding RapiDoc into Discourse posts

License

Notifications You must be signed in to change notification settings

grid-x/discourse-rapidoc-theme-component

Repository files navigation

Discourse Rapidoc Theme Component

This is a Discourse theme component that uses RapiDoc to render OpenAPI specifications inline in Discourse topics.

Based off the nice official Discourse mermaid component.

To use it ...

  • install it into your Discourse instance
  • in a topic, create a code block and use apidoc as language tag and the URL of an OpenAPI specification url as the block's content.
```apidoc
https://petstore.swagger.io/v2/swagger.json

If specification is not publicly accessible, you can attach the specification file to your post and copy the URL after the file has been uploaded.

Here's how it could look like rapidoc in discourse

About

Allows for embedding RapiDoc into Discourse posts

Resources

Stars

Watchers

Forks