docsify-edit-on-github

1.0.3 • Public • Published

docsify-edit-on-github

A plugin for docsify to generate a edit on github button on every pages. click the button to open corresponding md editing page on github.

<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
<script>
  window.$docsify = {
    // your config
    // ...
    plugins: [
      EditOnGithubPlugin.create(docBase, docEditBase, title)
    ]
  }
</script> 
  • docBase: [String] the document folder of your github project (e.g.: https://github.com/docsifyjs/docsify/blob/master/docs/)
  • docEditBase: [String] edit link of your github pages, by default, this is set automatically according to docBase
  • title: [String | Function] the text of the button, default value: Edit on github. If passed as function, then the title can be customized according to file path. for example:
      EditOnGithubPlugin.create(
        'https://github.com/docsifyjs/docsify/blob/master/docs/',
        null,
        function(file) {
          if (file.indexOf('en') === -1) {
            return '编辑'
          } else {
            return 'edit on git'
          }
        }
      )
    

Code example

Result example

Readme

Keywords

none

Package Sidebar

Install

npm i docsify-edit-on-github

Weekly Downloads

520

Version

1.0.3

License

ISC

Unpacked Size

5.68 kB

Total Files

5

Last publish

Collaborators

  • njleonzhang