You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING_FILE_FORMAT.md
+36-9Lines changed: 36 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ There are two types of pages: Welcome Pages and Documentation articles.
8
8
9
9
Documentation articles are markdown files structured under the [`src/data/markdown/docs`](src/data/markdown/docs) folder.
10
10
11
-
###Folder structure
11
+
## Folder structure
12
12
13
13
Root folders represent main categories at the top of the page.
14
14
Use numbers in front of the folder name to set the order.
@@ -53,7 +53,7 @@ Note, that path begins with `/`, not just `images/`.
53
53
54
54
Store images relative to a source `.md` file, and access them from `.md` files by using relative path. `image-sharp-plugin` will handle your image: compress, convert and lazy load.
55
55
56
-
### Example file structure:
56
+
### Example file structure
57
57
58
58
```
59
59
.
@@ -201,7 +201,7 @@ We are going to write them a bit differently, half-native md:
3. Replace `title`, `description`, `link` and image inside with your data. Note, that `title` and `link` are **required**, while `description` field and image inside are **optional**, though without an image it will look much less appealing.
Currently, this component is absent in k6-docs repo, though could be added anytime the need arises.
381
+
355
382
## Custom
356
383
357
384
It is also possible that you want to use a custom UI block in a certain `.md` document, not defined in this guide, like CTA button, or really any other piece of content from normal react page. By no means _do not copypast generated html into md file_: we are using `gatsby-plugin-mdx`, so please, just import the component you need right into `md` exactly the way you would import it on any react page and provide necessary props.
0 commit comments