Skip to content

Update README.md #1095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 15, 2023
Merged

Update README.md #1095

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,15 @@ Code snippets can be included by using the triple backticks syntax e.g. ` ```ard
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
```

### Including Code Blocks fetching Github pages

CodeBlocks are custom components that can be added directly in the Markdown on docs-content.
Using this component, the code block will be fetched directly from Github pages.

Syntax:
` <CodeBlock url=”https://github.com/example” className="{language}"/>`

Broken URL will show error alert. URL must be in Github domain and must be public.

## Previewing Changes

Expand Down