Skip to content

Commit

Permalink
Fix backtick code formatting in ApolloCompilerPlugin docs (#5849)
Browse files Browse the repository at this point in the history
* Fix backtick code formatting in ApolloCompilerPlugin docs

Note sure what the `<Note>` tag does but it was breaking the backtick markdown formatting

* trying to fix backticks

---------

Co-authored-by: Martin Bonnin <martin@mbonnin.net>
  • Loading branch information
edenman and martinbonnin committed Apr 24, 2024
1 parent 52bea72 commit dcf1497
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions docs/source/advanced/compiler-plugins.mdx
Expand Up @@ -62,9 +62,11 @@ Make your plugin discoverable by [ServiceLoader](https://docs.oracle.com/javase/
mypackage.MyPlugin
```

<Note>
<Note>

The name of the resource file is important. It must be `com.apollographql.apollo3.compiler.ApolloCompilerPlugin` and be in the `META-INF/services` folder. This is how `ServiceLoader` looks up plugins at runtime.
</Note>

# Adding a plugin to the Apollo compiler classpath

Use the `Service.plugin()` Gradle method to add the plugin to the Apollo compiler classpath:
Expand Down Expand Up @@ -121,4 +123,4 @@ Because codegen is run in a separate classloader when using compiler plugins, it

For other plugin APIs like layout, IR, JavaPoet and KotlinPoet transforms, check out the [ApolloCompilerPlugin API docs](https://www.apollographql.com/docs/kotlin/kdoc/apollo-compiler/com.apollographql.apollo3.compiler/-apollocompilerplugin/index.html)

For more examples, check out the [integration-tests](https://github.com/apollographql/apollo-kotlin/tree/main/tests/compiler-plugins).
For more examples, check out the [integration-tests](https://github.com/apollographql/apollo-kotlin/tree/main/tests/compiler-plugins).

0 comments on commit dcf1497

Please sign in to comment.