From 47e55646c8f0e630d4a6f780d3d6b4de78b0ff1a Mon Sep 17 00:00:00 2001 From: Waldir Pimenta Date: Tue, 29 Dec 2020 12:32:08 +0000 Subject: [PATCH 1/2] docs: Improve Quick start instructions - Slightly tweak Python server instructions to be more generic - Clarify the section about customizing the main container --- docs/quickstart.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 39a9328b1..e7263e91c 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -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 @@ -97,7 +97,8 @@ If you want, you can show a loading dialog before docsify starts to render your
Please wait...
``` -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 @@ -110,5 +111,3 @@ You should set the `data-app` attribute if you changed `el`: } ``` - -Compare [el configuration](configuration.md#el). From 64de258663b9217c0e5c43389d9a6021ea8956d0 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=B2=88=E5=94=81?= <52o@qq52o.cn> Date: Wed, 30 Dec 2020 08:25:13 +0800 Subject: [PATCH 2/2] Update quickstart.md --- docs/quickstart.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index e7263e91c..485b37691 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -97,8 +97,7 @@ If you want, you can show a loading dialog before docsify starts to render your
Please wait...
``` -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: +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