@sujaykumarh/docsify-plugin-title

Docsify Plugin Title

[!NOTE] v1.2.0 fixed typo #40 seprator in v1.x to separator as a breaking change was released earlier under v1.2.0 on 06-09-2023 and has since been unpublished as on 11-09-2023. Please upgrade to v2.x for typo fix

A simple plugin to customize docsify page title

📥 Download

• Locally

  npm install @sujaykumarh/docsify-plugin-title

• CDN

  <script src="//cdn.jsdelivr.net/npm/@sujaykumarh/docsify-plugin-title@2.x/dist/plugin.min.js"></script>

🧰 Configuration

Available options

window.$docsify.customPageTitle = {
    prefix:     false,      // [optional] title prefix. default: false eg: prefix: "Application"
    suffix:     false,      // [optional] title suffix. default: false eg: suffix: "v1.0.0"
    separator:   '|',       // [optional] separator for title eg: title->   prefix | title | suffix
    debug:      false,      // [optional] should debug
}

Example:

<script>
    ...

    window.$docsify.customPageTitle = {
        prefix:     'Docsify',     // title prefix.
        suffix:     'v1.0.0',      // title suffix.
    }

    ...
</script>

🛠️ Development

Clone

git clone https://github.com/sujaykumarh/docsify-plugin-title.git

install resources

npm install

minify src/plugin.js to generate minified files in dist folder

npm run minify  # generate minified .min.js in dist

📄 License

Copyright (c) 2021 Sujay H Licensed under Apache License v2.0 read LICENSE