KillDozerX2 / docsify-remote-markdown

Remote markdown plugin of docsify

docsify-remote-markdown

Install

1. Configure docsify-remote-markdown (optional):

   <script>
   window.$docsify = {
     remoteMarkdown: {
       tag: 'remoteMarkdownUrl',
     },
   }
   </script>

2. 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

• index.html
• README.md

License

This project is licensed under the MIT license.
Copyright (c) JerryC Huang ([e-mail])