From b90c948090e89fa778279c95060dbd7668285658 Mon Sep 17 00:00:00 2001 From: Anirudh Emmadi Date: Tue, 23 Jun 2020 12:11:20 -0500 Subject: [PATCH] fix: Updated docs with instructions for installing specific version (fixes #780) (#1225) * feat: Updated docs with instructions for installing specific version * Removed path and name from script tag * Updated stylesheet with specific version * Formatted and organized headings and html blocks for version specification * Removed html block for latest version --- docs/quickstart.md | 32 ++++++++++++++++++++++++++------ 1 file changed, 26 insertions(+), 6 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 5dc75728c..39a9328b1 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -47,7 +47,7 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr - +
@@ -56,11 +56,31 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr //... } - + ``` +### Specifying docsify versions + +?> Note that in both of the examples below, docsify URLs will need to be manually updated when a new major version of docsify is released (e.g. `v4.x.x` => `v5.x.x`). Check the docsify website periodically to see if a new major version has been released. + +Specifying a major version in the URL (`@4`) will allow your site will receive non-breaking enhancements (i.e. "minor" updates) and bug fixes (i.e. "patch" updates) automatically. This is the recommended way to load docsify resources. + +```html + + +``` + +If you prefer to lock docsify to a specific version, specify the full version after the `@` symbol in the URL. This is the safest way to ensure your site will look and behave the same way regardless of any changes made to future versions of docsify. + +```html + + +``` + +### Manually preview your site + If you installed python on your system, you can easily use it to run a static server to preview your site. ```bash @@ -72,17 +92,17 @@ cd docs && python -m SimpleHTTPServer 3000 If you want, you can show a loading dialog before docsify starts to render your documentation: ```html - + -
Please wait...
+
Please wait...
``` You should set the `data-app` attribute if you changed `el`: ```html - + -
Please wait...
+
Please wait...