mirror of
https://github.com/hasura/graphql-engine.git
synced 2024-12-15 17:31:56 +03:00
dc0dc30a06
## Description [Jira ticket](https://hasurahq.atlassian.net/jira/software/projects/DOCS/boards/19?selectedIssue=DOCS-102). This PR capitalizes Hasura features based on our [feature capitalization guide on the docs wiki](https://hasura.io/docs/wiki/style/hasura-features/). It also introduces some linting by prettier. PR-URL: https://github.com/hasura/graphql-engine-mono/pull/7260 Co-authored-by: Samir Talwar <47582+SamirTalwar@users.noreply.github.com> Co-authored-by: Luca Restagno <59067245+lucarestagno@users.noreply.github.com> Co-authored-by: hasura-bot <30118761+hasura-bot@users.noreply.github.com> Co-authored-by: Gil Mizrahi <8547573+soupi@users.noreply.github.com> Co-authored-by: Stefano Magni <173663+NoriSte@users.noreply.github.com> Co-authored-by: Daniel Harvey <4729125+danieljharvey@users.noreply.github.com> Co-authored-by: Abby Sassel <3883855+sassela@users.noreply.github.com> Co-authored-by: Daniele Cammareri <5709409+dancamma@users.noreply.github.com> Co-authored-by: Brandon Martin <40686+codedmart@users.noreply.github.com> GitOrigin-RevId: 5946f313cb44c639fac61e6c7fb44f704ee2a709
71 lines
1.8 KiB
Plaintext
71 lines
1.8 KiB
Plaintext
import Tabs from '@theme/Tabs';
|
|
import TabItem from '@theme/TabItem';
|
|
|
|
# Admonitions
|
|
|
|
Call-out admonitions allow you to highlight parts of the documentation which require special attention or which
|
|
don't fit in the usual flow of content.
|
|
|
|
```markdown
|
|
:::note
|
|
|
|
**This** is an example of a call-out admonition. For more info please get in touch with us on [Discord]
|
|
(https://discord.gg/vBPpJkS).
|
|
|
|
:::
|
|
```
|
|
|
|
```markdown
|
|
:::note Additional Resources
|
|
|
|
Data Federation with Hasura - [Watch Webinar](https://hasura.io/events/webinar/data-federation-hasura-graphql/).
|
|
|
|
:::
|
|
```
|
|
|
|
:::caution Please note the empty lines
|
|
|
|
Please ensure to leave empty lines in the start and the end (first and last lines). This to avoid prettier messing
|
|
up the formatting in this Docusaurus special syntax.
|
|
|
|
Read about it on the [Docusaurus Docs](https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier)
|
|
|
|
:::
|
|
|
|
```diff {1,3,5,7}
|
|
+
|
|
:::info Note
|
|
+
|
|
Make sure to place the note/admonition in a place where the user will see it at the appropriate time.
|
|
+
|
|
:::
|
|
+
|
|
```
|
|
|
|
which would render as below
|
|
|
|
:::note
|
|
|
|
**Adding an additional layer on top of the Hasura GraphQL Engine significantly impacts the performance provided by it
|
|
out of the box** (_by as much as 4x_). If you need any help with remodeling these kinds of use cases to use the built-in
|
|
Remote Schemas feature, please get in touch with us on [Discord](https://discord.gg/vBPpJkS).
|
|
|
|
:::
|
|
|
|
:::note Additionl Resources
|
|
|
|
Data Federation with Hasura - [Watch Webinar](https://hasura.io/events/webinar/data-federation-hasura-graphql/).
|
|
|
|
:::
|
|
|
|
<hr />
|
|
|
|
Please prefer `:::info Note` over `:::note` for a decent blue colored note.
|
|
|
|
:::info Note
|
|
|
|
For further syntax and usage reference please check docusaurus
|
|
[Admonitions docs](https://docusaurus.io/docs/markdown-features/admonitions)
|
|
|
|
:::
|