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

Skip to content

Commit b0c32d1

Browse files
Update README.md
1 parent e4bebe4 commit b0c32d1

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

docs/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
Convert your _docs_ folder into a pretty docs website using [DocsifyJS](https://docsify.js.org/) and some minimal setup instructions. This project's site itself is also running on _Docsify_.
99

1010

11-
## Links
11+
## Resource links
1212

1313
### My projects
1414

@@ -18,7 +18,7 @@ Convert your _docs_ folder into a pretty docs website using [DocsifyJS](https://
1818

1919
## Docsify repos
2020

21-
- [Docsify](https://github.com/docsifyjs/docsifyjs)
21+
- [Docsify](https://github.com/docsifyjs/docsify)
2222
- [Docsify CLI](https://github.com/docsifyjs/docsify-cli) on Github.
2323

2424

@@ -660,12 +660,14 @@ This command is for Server-Side Rendering. I haven't tried this yet.
660660

661661
### Server side rendering
662662

663-
Although SEO crawlers can do better at sites like single page application, _Docsify_ is still said not to be SEO-friendly, compared with static sites where all HTML is pre-rendered.
663+
Although SEO crawlers can do better at sites like single page application, _Docsify_ is still said to **not** be SEO-friendly, compared with static sites where all HTML is pre-rendered. Even though crawlers are getting better at handling JS for SPAs, I've read that this eats up the crawl budget so the crawler doesn't get far in your site.
664664

665665
However, _Docsify_ provides the option of pre-rendering all the views as static HTML. This can improve SEO.
666666

667667
See [Server-Side Rendering](https://docsify.js.org/#/ssr) section of the _Docsify_ docs.
668668

669+
I don't think it'll includes a sitemap file.
670+
669671

670672
### Why not use a static site generator?
671673

@@ -683,7 +685,7 @@ There are dependencies to manage - they might have to be upgraded if their are s
683685

684686
There is HTML to build locally and on the remote. While _Docsify_ needs no dependencies to serve a site, _Jekyll_ sites needs `jekyll` installed and _Hugo_ sites need `hugo` available.
685687

686-
A static site needs to to customize it in depth or setup a theme which also takes effort. You may lose or gain functionality when switching between Jekyll themes because they use their own templates and layouts.
688+
A static site needs to be customized in depth or needs theme setup which also takes effort. You may lose or gain functionality when switching between Jekyll themes because they use their own templates and layouts. MkDocs is another light alternative but have to install some themes and plugins locally.
687689

688690
You probably have to add _front matter_ to your doc files so they can inherit from layouts and have the correct metadata like title.
689691

0 commit comments

Comments
 (0)