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: docs/embed-files.md
+20-11
Original file line number
Diff line number
Diff line change
@@ -95,21 +95,31 @@ Embedding any type of source code file, you can specify the highlighted language
95
95
96
96
## Embed a gist
97
97
98
-
You can embed a gist as markdown content or as a code block. No plugin or app config change is needed - just an element which follows the formatting covered in [Embed files](#embed-files) and uses a raw gist URL.
98
+
You can embed a gist as markdown content or as a code block - this is based on the approach in the [Embed files](#embed-files) but uses raw gist URL as the target.
99
+
100
+
?> No plugin or app config change is needed here. In fact, an "Embed" script tag that is copied from a gist will _not_ load even if you make plugin or config changes to allow the external script.
101
+
102
+
### Identify gist metadata
99
103
100
104
Start by viewing a gist on `gist.github.com`.
101
105
102
-
For the purposes of the examples below, we assume is this is a valid gist URL.
106
+
For the purposes of this guide, we assume that is this is a valid gist URL:
?> The the `LABEL` will be the fallback text if the link is broken, so it is useful to repeat the filename in the label.
141
+
132
142
### Render codeblock from gist
133
143
134
-
Embed a gist on your Docsify page as a code block. The format is the same as the previous section except it just has `:type=code` added on in the alt text.
144
+
Embed a gist on your Docsify page as a code block. The format is the same as the previous section, but with `:type=code` added to the alt text.
135
145
136
-
As with the [Embedded file type](#embedded-file-type) section, the syntax highlighting will be inferred from the extension (e.g. `.js` or `.py`) so you can leave the type as `code`.
146
+
?> As with the [Embedded file type](#embedded-file-type) section, the syntax highlighting will be inferred from the extension (e.g. `.js` or `.py`) so you can leave the type as the generic value of`code`.
0 commit comments