These are built-in and external plugins for Docsify.
See also how to Write a Plugin.
By default, the hyperlink on the current page is recognized and the content is saved in IndexedDB. You can also specify the path to the files.
<script>window.$docsify={search: 'auto',// defaultsearch: ['/',// => /README.md'/guide',// => /guide.md'/get-started',// => /get-started.md'/zh-cn/',// => /zh-cn/README.md],// Complete configuration parameterssearch: {// Location in sidebar (default: prepended as first child)// Optionally specify insertAfter or insertBefore (not both)insertAfter: '.app-name',// CSS selector in .sidebar scopeinsertBefore: '.sidebar-nav',// CSS selector in .sidebar scopemaxAge: 86400000,// Expiration time, the default one daypaths: [],// string[] of files to search in, or 'auto' for discovery based on your sidebarplaceholder: 'Type to search',// Localizationplaceholder: {'/zh-cn/': '搜索','/': 'Type to search',},noData: 'No Results!',// LocalizationnoData: {'/zh-cn/': '找不到结果','/': 'No Results',},// Headline depth, 1 - 6depth: 2,hideOtherSidebarContent: true,// Deprecated as of v5// To avoid search index collision// between multiple websites under the same domainnamespace: 'website-1',// Use different indexes for path prefixes (namespaces).// NOTE: Only works in 'auto' mode.//// When initialiazing an index, we look for the first path from the sidebar.// If it matches the prefix from the list, we switch to the corresponding index.pathNamespaces: ['/zh-cn','/ru-ru','/ru-ru/v1'],// You can provide a regexp to match prefixes. In this case,// the matching substring will be used to identify the indexpathNamespaces: /^(\/(zh-cn|ru-ru))?(\/(v1|v2))?/,// Show where each result comes from (default: 'none')// 'page': the page title, e.g. "Guide"// 'breadcrumb': the sidebar path, e.g. "Basics › Guide"resultSource: 'none',},};</script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/search.min.js"></script>This plugin ignores diacritical marks when performing a full text search (e.g., "cafe" will also match "café").
Google's Universal Analytics service will no longer process new data in standard properties beginning July 1, 2023. Prepare now by setting up and switching over to a Google Analytics 4 property and docsify's gtag.js plugin.
Install the plugin and configure the track id.
<script>window.$docsify={ga: 'UA-XXXXX-Y',};</script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/ga.min.js"></script>Configure by data-ga.
<scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js" data-ga="UA-XXXXX-Y"></script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/ga.min.js"></script>Install the plugin and configure the track id.
<script>// Single IDwindow.$docsify={gtag: 'UA-XXXXX-Y',};// Multiple IDswindow.$docsify={gtag: ['G-XXXXXXXX',// Google Analytics 4 (GA4)'UA-XXXXXXXX',// Google Universal Analytics (GA3)'AW-XXXXXXXX',// Google Ads'DC-XXXXXXXX',// Floodlight],};</script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/gtag.min.js"></script>Renders a larger collection of emoji shorthand codes. Without this plugin, Docsify is able to render only a limited number of emoji shorthand codes.
[!IMPORTANT] Deprecated as of v4.13. Docsify no longer requires this plugin for full emoji support.
<scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/emoji.min.js"></script>If the script on the page is an external one (imports a js file via src attribute), you'll need this plugin to make it work.
<scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/external-script.min.js"></script>Medium's image zoom. Based on medium-zoom.
<scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/zoom-image.min.js"></script>Exclude the special image
Add Edit on github button on every page. Provided by @njleonzhang, see this document
With this plugin, sample code can be rendered on the page instantly, so that the readers can see the preview immediately.
When readers expand the demo box, the source code and description are shown there. if they click the button Try in Jsfiddle,
jsfiddle.net will be open with the code of this sample, which allow readers to revise the code and try on their own.
Vue and React are both supported.
Add a simple Click to copy button to all preformatted code blocks to effortlessly allow users to copy example code from your docs. Provided by @jperasmus
<scriptsrc="//cdn.jsdelivr.net/npm/docsify-copy-code/dist/docsify-copy-code.min.js"></script>See here for more details.
Disqus comments. https://disqus.com/
<script>window.$docsify={disqus: 'shortname',};</script><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/disqus.min.js"></script>Gitalk is a modern comment component based on GitHub Issue and Preact.
<linkrel="stylesheet" href="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.css" /><scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/plugins/gitalk.min.js"></script><scriptsrc="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script><script>constgitalk=newGitalk({clientID: 'GitHub Application Client ID',clientSecret: 'GitHub Application Client Secret',repo: 'GitHub repo',owner: 'GitHub repo owner',admin: ['GitHub repo collaborators, only these guys can initialize github issues',],// facebook-like distraction free modedistractionFreeMode: false,});</script>Pagination for docsify. By @imyelo
<scriptsrc="//cdn.jsdelivr.net/npm/docsify@5/dist/docsify.min.js"></script><scriptsrc="//cdn.jsdelivr.net/npm/docsify-pagination/dist/docsify-pagination.min.js"></script>Click here to get more information.
A docsify.js plugin for displaying tabbed content from markdown.
Provided by @jhildenbiddle.
See awesome-docsify