Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
anikethsaha merged 7 commits into from
Jun 23, 2020
Merged

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

Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b011bb8
feat: Updated docs with instructions for installing specific version
aemmadi Jun 12, 2020
6b7870c
Merge branch 'develop' into feature/update-docs-manual-version
aemmadi Jun 16, 2020
9bbc5b8
Removed path and name from script tag
aemmadi Jun 18, 2020
05753ee
Updated stylesheet with specific version
aemmadi Jun 18, 2020
92b0e39
Formatted and organized headings and html blocks for version specific…
aemmadi Jun 22, 2020
82b80af
Removed html block for latest version
aemmadi Jun 23, 2020
352aac6
Merge branch 'develop' into feature/update-docs-manual-version
aemmadi Jun 23, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 25 additions & 5 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- index.html -->
Expand All @@ -61,6 +61,26 @@ If you don't like `npm` or have trouble installing the tool, you can manually cr
</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/[email protected]/themes/vue.css">
<script src="//cdn.jsdelivr.net/npm/[email protected]"></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
Expand All @@ -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 = {
Expand Down