From b011bb8226190053094c85d13a8264177dd07254 Mon Sep 17 00:00:00 2001 From: Anirudh Emmadi Date: Fri, 12 Jun 2020 13:55:42 -0500 Subject: [PATCH 1/5] feat: Updated docs with instructions for installing specific version --- docs/quickstart.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) diff --git a/docs/quickstart.md b/docs/quickstart.md index 5dc75728c..efd61fa87 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -61,6 +61,32 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr ``` +If you want to install a specific version of docsify, you can manually create `index.html`: + +```html +!-- index.html --> + + + + + + + + + + +
+ + + + + +``` + If you installed python on your system, you can easily use it to run a static server to preview your site. ```bash From 9bbc5b84fcb84ad78c1dd8b01e1d78679e6b66d9 Mon Sep 17 00:00:00 2001 From: Anirudh Emmadi Date: Thu, 18 Jun 2020 11:27:52 -0500 Subject: [PATCH 2/5] Removed path and name from script tag --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index efd61fa87..f1f81d4a5 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -82,7 +82,7 @@ If you want to install a specific version of docsify, you can manually create `i } - + ``` From 05753ee8412e9e9a92244e43c9ccc2bc0270e492 Mon Sep 17 00:00:00 2001 From: Anirudh Emmadi Date: Thu, 18 Jun 2020 11:32:17 -0500 Subject: [PATCH 3/5] Updated stylesheet with specific version --- docs/quickstart.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index f1f81d4a5..94b30fce3 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -72,7 +72,8 @@ If you want to install a specific version of docsify, you can manually create `i - + +
From 92b0e398c7160a176c082d3354e1f94494a644ec Mon Sep 17 00:00:00 2001 From: Anirudh Emmadi Date: Mon, 22 Jun 2020 10:46:04 -0500 Subject: [PATCH 4/5] Formatted and organized headings and html blocks for version specification --- docs/quickstart.md | 47 ++++++++++++++++++++-------------------------- 1 file changed, 20 insertions(+), 27 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 94b30fce3..c1b18c79a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -36,7 +36,7 @@ docsify serve docs ## Manual initialization -If you don't like `npm` or have trouble installing the tool, you can manually create `index.html`: +If you don't like `npm` or have trouble installing the tool, you can manually create `index.html` (the code below will load the latest version of docsify automatically. If you want a specific version to avoid any broken elements in the future, [see below](#specifying-docsify-versions)): ```html @@ -61,33 +61,26 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr ``` -If you want to install a specific version of docsify, you can manually create `index.html`: +### 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 -!-- index.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 @@ -99,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...
- + ```