docsify-versioned-plugin v0.0.1

Docsify Versioned Plugin

The Docsify Versioned Plugin allows you to manage and display multiple versions of your documentation using a simple dropdown selector. Users can easily switch between different versions of the documentation, while the plugin ensures that the content and links are updated accordingly.

Installation

1. Add the following script tag to your index.html file, preferably after the Docsify script:

<script src="index.js"></script>

2. Add the following style tag to your index.html file to include the plugin's CSS:

<link rel="stylesheet" href="styles.css">

Configuration

In your index.html file, update the Docsify configuration to include the versions and default version:

window.$docsify = {
  // ... Other configuration options
  versions: [
    { folder: 'v1', label: 'v1.0.0', default: false },
    { folder: 'v2', label: 'v2.0.0', default: true },
  ],
};

Update the versions array with your version names and folders. Set the default property to true for the version you want to display by default.

Make sure the respective folder exists. Labels can be updated without the need to change the folder name.

Usage

Once the plugin is installed and configured, it will automatically display a dropdown selector at the top of the navigation bar, allowing users to switch between different versions of the documentation. The content and links will be updated accordingly based on the selected version.

In your Markdown files, you can use the {{versionLabel}} placeholder to display the current version label. For example, you can include the following line in your _coverpage.md file:

# My Project Documentation ({{versionLabel}})

This will display the current version label (e.g., "v1.0.0" or "v2.0.0") next to the project title on the cover page.

Limitations

Current limitations are as follows:

• Search plugin does not properly work if the content found is not present in active version, 404 will be displayed.
• Images or other assets need to be stored within the respective version-folder, a direct access to an outside folder is not possible.
• Styling is adapted to theme-simple, might not look as good with other themes.

License

MIT License.