docsify-docbucket

docsify-docbucket

A Docsify plugin that help building documentation site with Docsify and Pages for Bitbucket Server. The plugin require docsify-bitbucket plugin as dependency. This plugin works with Bitbucket Server only, Bitbucket Cloud not supported.

Installation

Add following script tags to your index.html after docsify.

<script src="//cdn.jsdelivr.net/npm/docsify-bitbucket"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-docbucket"></script>

Options

navbar

If loadNavbar parameter is missing from Docsify configuration then the plugin will use _navbar.md from the doc repository in the current Bitbucket Server project. You can disable this feature:

window.$docsify = {
  docbucket: {
    noNavbar : true
  }
}

style

By default the plugin will load style.css from the doc repository in the current Bitbucket Server project. You can disable this feature:

window.$docsify = {
  docbucket: {
    noStyle : true
  }
}

script

The plugin is able to load script (JavaScript) script.js from the doc repository in the current Bitbucket Server project. You can enable this feature:

window.$docsify = {
  docbucket: {
    loadScript : true
  }
}

You can also specify other script file name:

window.$docsify = {
  docbucket: {
    loadScript : '/;r=doc/plugin.js'
  }
}

License

This project is licensed under the MIT License. See the LICENSE for details.