Merge pull request #1734 from docsifyjs/mark-ssr-as-experimental

docs: mention that SSR is experimental and incomplete, …
This commit is contained in:
Joe Pea 2022-01-26 08:59:54 -08:00 committed by GitHub
commit b58941e88b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 10 additions and 3 deletions

View File

@ -46,7 +46,7 @@
- Multiple themes
- Useful plugin API
- Compatible with IE11
- Support SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
- Experimental SSR support ([example](https://github.com/docsifyjs/docsify-ssr-demo))
- Support embedded files
## Quick start

View File

@ -1,10 +1,17 @@
# Server-Side Rendering
See https://docsify.now.sh
!> :construction: SSR support is experimental and incomplete. We are working on it. Plugins and
some features of Docsify will not work in SSR mode yet. :construction:
Repo in https://github.com/docsifyjs/docsify-ssr-demo
<!--
This link is dead.
See https://docsify.now.sh
-->
Sample repo at https://github.com/docsifyjs/docsify-ssr-demo
## Why SSR?
- Better SEO
- Feeling cool