You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The HTML rendered by docsify-cli and listed in the Manual Installation section of the official docs results in the very latest version of docsify being loaded by default. This is not only bad practice generally speaking, but it also means that breaking changes introduced in a new major release could break a lot of live docsify sites.
The suggested fix is to specify a major version number in all docsify URLs:
This means that when a new major version is released, site admins will need to manually update the URLs with the new major version number (e.g. @5). The benefit of this approach is that breaking changes in the new release will not affect existing docsify sites since they are loading the previous version.
If URLs are being updated, it's also worth considering the following:
Use CDN redirect URLs instead of specifying a path for the main lib file
Specify the URL scheme to avoid unnecessary redirects (i.e use https:// instead of //)
The HTML rendered by docsify-cli and listed in the Manual Installation section of the official docs results in the very latest version of docsify being loaded by default. This is not only bad practice generally speaking, but it also means that breaking changes introduced in a new major release could break a lot of live docsify sites.
The suggested fix is to specify a major version number in all docsify URLs:
This means that when a new major version is released, site admins will need to manually update the URLs with the new major version number (e.g.
@5). The benefit of this approach is that breaking changes in the new release will not affect existing docsify sites since they are loading the previous version.If URLs are being updated, it's also worth considering the following:
https://instead of//)