Skip to content

docs: Improve Quick start instructions #1466

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
merged 4 commits into from
Jul 30, 2025
+1 −3
Merged

docs: Improve Quick start instructions #1466

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a91aca4
docs: Improve Quick start instructions
waldyrious Dec 31, 2020
91acaae
Merge branch 'develop' into patch-1
sy-records Feb 4, 2021
db63e37
Merge branch 'develop' into patch-1
jhildenbiddle Mar 18, 2022
0daf1ad
Merge branch 'develop' into patch-1
sy-records Jul 30, 2025
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
6 changes: 2 additions & 4 deletions docs/quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ If you prefer to lock docsify to a specific version, specify the full version af

### 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.
If you have Python installed on your system, you can easily use it to run a static server to preview your site.

```bash
cd docs && python -m SimpleHTTPServer 3000
Expand All @@ -97,7 +97,7 @@ If you want, you can show a loading dialog before docsify starts to render your
<div id="app">Please wait...</div>
```

You should set the `data-app` attribute if you changed `el`:
By default, the `id` attribute of the main container is `app`. If you want to use a different id, you must also set the `data-app` attribute, and [configure](configuration.md#el) the `el` parameter accordingly:

```html
<!-- index.html -->
Expand All @@ -110,5 +110,3 @@ You should set the `data-app` attribute if you changed `el`:
}
</script>
```

Compare [el configuration](configuration.md#el).