docsify-remote-markdown
v1.0.1
Published
remote markdown plugin of docsify
Downloads
1,278
Readme
docsify-remote-markdown
Install
Configure docsify-remote-markdown (optional):
<script> window.$docsify = { remoteMarkdown: { tag: 'remoteMarkdownUrl', }, } </script>
Insert script into docsify document:
<script src="//unpkg.com/docsify-remote-markdown/dist/docsify-remote-markdown.min.js"></script>
Usage
Write your remote-markdown code like this:
[remoteMarkdownUrl](https://raw.githubusercontent.com/docsifyjs/docsify/develop/README.md)
It will be replaced by the raw text of the url above into your doc file content.
Options
tag
By default, we set the tag as remoteMarkdownUrl
for you.
However, you can change this options as you like:
window.$docsify = {
remoteMarkdown: {
tag: 'customTag',
},
}
Will match the code in you doc file:
[customTag](https://raw.githubusercontent.com/docsifyjs/docsify/develop/README.md)
Example
License
This project is licensed under the MIT license.
Copyright (c) JerryC Huang ([email protected])