1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
---
title: Test doc page
toc: true
---
# This is a test doc page
Some examples of things you can do in docs.
## Code highlighting
Code blocks now support:
### Highlighting words individually
```python highlight=strawberry,str
import strawberry
@strawberry.type
class X:
name: str
```
### Highlighting lines
```python lines=1-4
import strawberry
@strawberry.type
class X:
name: str
```
### Add notes to code comments
This is probably not implemented in the best way, but for now it works:
```python
import strawberry
# ^^^^^^^^^^
# This is a note about this line
# this is a standard comment
@strawberry.type
class X:
name: str
```
<CodeNotes id="info">Strawberry is a cool library</CodeNotes>
### Split code blocks
You can show two different code blocks next to each other (useful when comparing
the GraphQL schema against the Python definition):
<CodeGrid>
```python
import strawberry
@strawberry.type
class Query:
@strawberry.field
def ping(self) -> str:
return "pong"
```
```graphql
type Query {
ping: String!
}
```
</CodeGrid>
or when showing the request and response to a query:
```graphql+response
{
ping
}
---
{
"data": {
"ping": "pong"
}
}
```
## Call out blocks
<Tip>
This is a tip. Useful information is contained here.
</Tip>
<Note>
This is a note. Something that you should know about.
</Note>
<Warning>
This is a warning. Something that you should be careful about.
</Warning>
## Blockquote
> This is a quote
```mermaid
sequenceDiagram
Alice ->> Bob: Hello Bob, how are you?
Bob-->>John: How about you John?
Bob--x Alice: I am good thanks!
Bob-x John: I am good thanks!
Note right of John: Bob thinks a long<br/>long time, so long<br/>that the text does<br/>not fit on a row.
Bob-->Alice: Checking with John...
Alice->John: Yes... John, how are you?
```
|
