You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/README.md
+6-4Lines changed: 6 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@
8
8
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_.
9
9
10
10
11
-
## Links
11
+
## Resource links
12
12
13
13
### My projects
14
14
@@ -18,7 +18,7 @@ Convert your _docs_ folder into a pretty docs website using [DocsifyJS](https://
-[Docsify CLI](https://github.com/docsifyjs/docsify-cli) on Github.
23
23
24
24
@@ -660,12 +660,14 @@ This command is for Server-Side Rendering. I haven't tried this yet.
660
660
661
661
### Server side rendering
662
662
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.
664
664
665
665
However, _Docsify_ provides the option of pre-rendering all the views as static HTML. This can improve SEO.
666
666
667
667
See [Server-Side Rendering](https://docsify.js.org/#/ssr) section of the _Docsify_ docs.
668
668
669
+
I don't think it'll includes a sitemap file.
670
+
669
671
670
672
### Why not use a static site generator?
671
673
@@ -683,7 +685,7 @@ There are dependencies to manage - they might have to be upgraded if their are s
683
685
684
686
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.
685
687
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.
687
689
688
690
You probably have to add _front matter_ to your doc files so they can inherit from layouts and have the correct metadata like title.
0 commit comments