Skip to content

Commit 04f74b2

Browse files
authored
Update README.md (#1095)
1 parent 8500044 commit 04f74b2

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,15 @@ Code snippets can be included by using the triple backticks syntax e.g. ` ```ard
8787
arduino, bash, markup, clike, c, cpp, css, css-extras, javascript, jsx, js-extras, coffeescript, diff, git, go, graphql, handlebars, json, less, makefile, markdown, objectivec, ocaml, python, reason, sass, scss, sql, stylus, tsx, typescript, wasm, yaml
8888
```
8989

90+
### Including Code Blocks fetching Github pages
91+
92+
CodeBlocks are custom components that can be added directly in the Markdown on docs-content.
93+
Using this component, the code block will be fetched directly from Github pages.
94+
95+
Syntax:
96+
` <CodeBlock url=”https://github.com/example” className="{language}"/>`
97+
98+
Broken URL will show error alert. URL must be in Github domain and must be public.
9099

91100
## Previewing Changes
92101

0 commit comments

Comments
 (0)