docsify-bitbucket

A Docsify plugin that help using Docsify with Pages for Bitbucket Server and Bitbucket Cloud.

Docsify version of this documentation can be found at https://docsify-bitbucket.github.io

Installation

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

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

Options

repo

If repo parameter is missing from Docsify configuration then the plugin detect Butbucket repository URL and use it as Docsify repo parameter. You can disable this feature:

window.$docsify = {
  bitbucket: {
    noRepo : true
  }
}

On Bitbucket Cloud the repository detection is limited to web pages served from bitbucket.io domain.

corner icon

If repo parameter is set (or detected) then the plugin replaces the default GitHub repository corner picture with Bitbucket logo. You can disable this feature:

window.$docsify = {
  bitbucket: {
    noCorner : true
  }
}

logo

If logo parameter is missing from Docsify configuration then the plugin detect the Bitbucket project and use project's logo as Docsify logo parameter. You can disable this feature:

window.$docsify = {
  bitbucket: {
    noLogo : true
  }
}

On Bitbucket Cloud the plugin use repository's avatar as default logo.

favicon

If shortcut icon HTML link element is missing from enclosing HTML document then the plugin detect the Bitbucket project and use project's logo as shortcut icon (favicon). You can disable this feature:

window.$docsify = {
  bitbucket: {
    noFavicon : true
  }
}

On Bitbucket Cloud the plugin use repository's avatar as default favicon.

repository links

The plugin resolves special repository URLs to real Bitbucket Server URLs. Using this feature makes easy to link documents in other repositories either in same Bitbucket project or in another one. The first path segment (the first /) may have path parameters defined in RFC 3986 - Uniform Resource Identifier / 3.3 Path. The following path segment parameters are handled by plugin:

parameter	value
p	Bitbucket project key, project's short name or ~username for personal repositories
r	Bitbucket git repository name
b	Branch name

Repository URI format:

/;p=project;r=repository;b=branch/path

The project and branch part is optional but the repository part is required. The default value of the project is the project of the enclosing markdown document. The default value of the branch is the main branch.

Example for referencing main branch of repository sample in same project as referring document:

/;r=sample

The path part may conain any path relative to referred branch:

/;r=sample/docs/tutorial/intro

You can disable this feature:

window.$docsify = {
  bitbucket: {
    noLink : true
  }
}

Repository URI resolution feture works only with Pages for Bitbucket Server.

title

If title HTML element is missing from enclosing HTML document then the plugin set it based on the first markdown heading line of the current document. You can disable this feature:

window.$docsify = {
  bitbucket: {
    noTitle : true
  }
}

Sample

Sample website can be found at https://docsify-bitbucket.bitbucket.io/sample

License

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

ytldsimage / docsify-bitbucket.github.io Goto Github PK