hpx7/docsify-plugin-title

:electric_plug: Docsify plugin customize page title

Docsify Plugin Title

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@1.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"
    seprator:   '|',        // [optional] seprator 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 Sujaykumar.Hublikar <hello@sujaykumarh.com>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.