Skip to content

JerryC8080/docsify-remote-markdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

docsify-remote-markdown

npm

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

License

This project is licensed under the MIT license.
Copyright (c) JerryC Huang ([email protected])

About

Remote markdown plugin of docsify

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published