Skip to content

Commit bebd2a9

Browse files
Clarify embed file explanations
1 parent 13f91a4 commit bebd2a9

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

docs/embed-files.md

+7-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
# Embed files
22

33
With docsify 4.6 it is now possible to embed any type of file.
4+
45
You can embed these files as video, audio, iframes, or code blocks, and even Markdown files can even be embedded directly into the document.
56

6-
For example, here embedded a Markdown file. You only need to do this:
7+
For example, here is an embedded Markdown file. You only need to do this:
78

89
```markdown
910
[filename](_media/example.md ':include')
1011
```
1112

12-
Then the content of `example.md` will be displayed directly here
13+
Then the content of `example.md` will be displayed directly here;
1314

1415
[filename](_media/example.md ':include')
1516

@@ -19,23 +20,23 @@ Normally, this will compiled into a link, but in docsify, if you add `:include`
1920

2021
## Embedded file type
2122

22-
Currently, file extension are automatically recognized and embedded in different ways.
23+
Currently, file extensions are automatically recognized and embedded in different ways.
2324

24-
This is a supported embedding type:
25+
These types are supported:
2526

2627
* **iframe** `.html`, `.htm`
2728
* **markdown** `.markdown`, `.md`
2829
* **audio** `.mp3`
2930
* **video** `.mp4`, `.ogg`
3031
* **code** other file extension
3132

32-
Of course, you can force the specified. For example, you want to Markdown file as code block embedded.
33+
Of course, you can force the specified type. For example, a Markdown file can be embedded as a code block by setting `:type=code`.
3334

3435
```markdown
3536
[filename](_media/example.md ':include :type=code')
3637
```
3738

38-
You will get it
39+
You will get:
3940

4041
[filename](_media/example.md ':include :type=code')
4142

0 commit comments

Comments
 (0)