Skip to content

docs: Improve Quick start instructions #1458

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 2 commits into from
Dec 30, 2020
Merged

docs: Improve Quick start instructions #1458

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
47e5564
docs: Improve Quick start instructions
waldyrious Dec 29, 2020
64de258
Update quickstart.md
sy-records Dec 30, 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
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:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit weird that we need to set data-app like this. Let's fix in v5.

/wish-there-was-a-bot-command-to-open-an-new-issue-right-from-here

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added it manually https://github.com/docsifyjs/docsify/projects/2#card-51972364

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sy-records let's get things moving. Let's make changes more organic (as per the other v5 topic I closed), and we can release a major version bump any time we fix a small feature that is breaking. In this case, this one is worth it in my opinion.


```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).