Commit cca9d5e

authored

Update README.md

1 parent 3f14679 commit cca9d5eCopy full SHA for cca9d5e

File tree

1 file changed

+35

-24

lines changed

docs
- README.md

1 file changed

+35

-24

lines changed

`‎docs/README.md‎`

Lines 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.
	`768`	`+- On the static server.`
	`769`	+ e.g. `foo/hello.md`
`770`	`770`
`771`		-```
`772`		`-':include :type=code'`
`773`		-```
	`771`	+ ```markdown
	`772`	`+ [hello.js](/path/to/hello.md ":include")`
	`773`	+ ```
	`774`	`+- URL for a file on a public GitHub repo.`
	`775`	`+ - e.g.`
	`776`	+ ```markdown
	`777`	`+ [hello.md](//raw.githubusercontent.com/UserName/repo-name/main/hello.md ":include")`
`774`	`778`
`775`		`-See the _Docsify_ [Embed](https://docsify.js.org/#/embed-files) help for forcing types and using fragments.`
	`779`	`+ [\_sidebar.md](//raw.githubusercontent.com/MichaelCurrin/docsify-js-tutorial/master/nested-example/_sidebar.md ":include :type=code")`
	`780`	+ ```
	`781`	`+ - Make sure to use the raw URL so you only reference plain text andbnot the entire GitHub UI HTML.`
	`782`	+ - A protocol of `//` is recommended, since `https://` is needed for a remote and `http://` for localhost, to avoid a CORS error.
	`783`	`+- A gist reference.`
	`784`	`+ - See instructions in this [guide](https://gist.github.com/MichaelCurrin/c2bece08f27c4277001f123898d16a7c).`
	`785`	`+`
	`786`	`+See the _Docsify_ [Embed Files](https://docsify.js.org/#/embed-files) help for forcing types and using fragments.`
`776`	`787`
`777`	`788`
`778`	`789`	`#### Embed examples`
`@@ -791,6 +802,7 @@ Result:`
`791`	`802`
`792`	`803`	`[example.js](_media/example.js ':include' )`
`793`	`804`
	`805`	`+If you have a site on GitHub Pages subpath, make sure to avoid leading forward slash.`
`794`	`806`
`795`	`807`	`##### Markdown as code snippet`
`796`	`808`
`@@ -806,24 +818,23 @@ Result:`
`806`	`818`
`807`	`819`	`[\_sidebar.md](_coverpage.md ':include :type=code')`
`808`	`820`
`809`		`-`
`810`	`821`	`##### Markdown as rendered HTML`
`811`	`822`
`812`		-Render target markdown file as HTML. Leave out the `type` parameter.
	`823`	+Render target Markdown file as HTML. Leave out the `type` parameter.
`813`	`824`
`814`	`825`	`Code:`
`815`	`826`
`816`	`827`	```markdown
`817`		`-[example.md](https://docsify.js.org/_media/example.md ':include')`
	`828`	`+[example.md](https://docsify.js.org/_media/example.md ":include")`
`818`	`829`	```
`819`	`830`
`820`	`831`	`Result:`
`821`	`832`
`822`		`-[example.md](https://docsify.js.org/_media/example.md ':include')`
	`833`	`+[example.md](https://docsify.js.org/_media/example.md ":include")`
`823`	`834`
`824`		`-Raw markdown:`
	`835`	`+Raw Markdown at that URL:`
`825`	`836`
`826`		`-[example.md](https://docsify.js.org/_media/example.md ':include :type=code')`
	`837`	`+[example.md](https://docsify.js.org/_media/example.md ":include :type=code")`
`827`	`838`
`828`	`839`
`829`	`840`	`#### Warnings`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit cca9d5e

File tree

1 file changed

1 file changed

`‎docs/README.md‎`

0 commit comments