archive-gh-me/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00
Code Issues Projects Releases Wiki Activity

fix: Updated docs with instructions for installing specific version (fixes #780) (#1225)

Browse Source 
* 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
This commit is contained in:
Anirudh Emmadi 2020-06-23 12:11:20 -05:00 committed by GitHub
parent 3673001a24
commit b90c948090
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
docs/quickstart.md
View File

@ -47,7 +47,7 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta charset="UTF-8">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify/themes/vue.css">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
</head>
<body>
<div id="app"></div>
@ -56,11 +56,31 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr
//...
}
</script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
</body>
</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
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/themes/vue.css" />
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
```
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
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4.11.4/themes/vue.css">
<script src="//cdn.jsdelivr.net/npm/docsify@4.11.4"></script>
```
### 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
<!-- index.html -->
<!-- index.html -->
<div id="app">Please wait...</div>
<div id="app">Please wait...</div>
```
You should set the `data-app` attribute if you changed `el`:
```html
<!-- index.html -->
<!-- index.html -->
<div data-app id="main">Please wait...</div>
<div data-app id="main">Please wait...</div>
<script>
window.$docsify = {