Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 15f7c7c

Browse files
Update README.md
1 parent 4e53f42 commit 15f7c7c

File tree

1 file changed

+17
-1
lines changed

1 file changed

+17
-1
lines changed

docs/README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -739,8 +739,12 @@ e.g.
739739
```bash
740740
$ docsify serve docs
741741
```
742+
```
743+
Serving .../docsify-js-tutorial/docs now.
744+
Listening at http://localhost:3000
745+
```
742746

743-
Serves as [localhost:3000/](http://localhost:3000/), or a different port if there is already a _Docsify_ server running.
747+
Serves at [localhost:3000/](http://localhost:3000/), or a different port if there is already a _Docsify_ server running.
744748

745749
This uses is the main use for Docsify - an `index.html` page is served, the JS is loaded on the frontend and then markdown pages are requested and converted to HTML as needed. It is a **Single-Page Application**, so will work great from a user perspective but will score low on search engines. Even though the SEO crawlers can handle JavaScript, there is limited "crawl budget" for a JavaScript-based SPA so this means less of your site is crawled or your site is rated poorly. Constrast with the option below.
746750

@@ -750,6 +754,18 @@ This uses is the main use for Docsify - an `index.html` page is served, the JS i
750754

751755
This command is for Server-Side Rendering.
752756

757+
e.g.
758+
759+
```bash
760+
$ docsify start docs
761+
```
762+
```
763+
[SSR] Serving docs now.
764+
Listening at http://localhost:4000
765+
```
766+
767+
Serves at [localhost:3000/](http://localhost:3000/)
768+
753769
This runs a Node.js server which pre-renders then serves HTML to the browser. This should make almost no difference to the end-user.
754770

755771
This approach is ideal for scoring higher on search engines, as the pre-rendered HTML is easy for a crawler to read and it does not use up the "crawl budget".

0 commit comments

Comments
 (0)