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/README.md
+35-24Lines changed: 35 additions & 24 deletions
Original file line number
Diff line number
Diff line change
@@ -738,41 +738,52 @@ To make the most of Docsify, update your content using the next section.
738
738
739
739
740
740
## Write content
741
-
> How to update and add to the content of your doc files so that they work well in Docsify.
741
+
> How to update and add to the content of your doc files so that they work well in Docsify
742
742
743
743
744
744
### Embed
745
745
746
-
You can embed content such as video, audio, iframes (`.html`), code blocks or even Markdown files.
746
+
You can embed content such as
747
+
748
+
- Media - video, audio, iframes (`.html`)
749
+
- Code that appears as a code block
750
+
- Markdown or HTML that gets rendered on the page seamlessly.
747
751
748
752
#### Embed format
749
753
750
754
Add the `":include"` parameter in a markdown URL reference. Here is the format:
751
755
752
756
```markdown
753
-
[filename](url ":include")
757
+
[LABEL](PATH ":include")
754
758
```
755
759
756
-
The URL could be a local file (e.g. `_media/foo.js`) or a remote URL `https://...`.
760
+
If you want to embed as a **code block**, you can use the automatic formatting. But markdown and HTML files need to be marked as a code using `type` parameter if you want them as code rather than HTML.
757
761
758
-
The remote file could be anywhere:
762
+
```
763
+
":include :type=code"
764
+
```
759
765
760
-
- On a server
761
-
- e.g. `assets/js/main.js`
762
-
- Repo reference
763
-
- Use the **raw** URL so you only reference plain text.
764
-
- Protocol of `//` is recommended, since `https://` is needed for a remote and `http://` for localhost, to avoid a CORS error.
765
-
- e.g. `https://raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/nested-example/_sidebar.md`
766
-
- A gist reference
767
-
- See instructions in this [guide](https://gist.github.com/MichaelCurrin/c2bece08f27c4277001f123898d16a7c).
766
+
The path could be:
768
767
769
-
If you want to embed a code block, you can use the automatic formatting. But markdown and HTML files need to be marked as a code using `type` parameter if you want them as code rather than HTML.
0 commit comments