From 47cb36e74d8b639489db18eb1ea3793050382257 Mon Sep 17 00:00:00 2001 From: Joe Pea Date: Sun, 23 Jan 2022 19:42:58 -0800 Subject: [PATCH] mention that SSR is experimental and incomplete, prevent people from using it thinking it is ready for prime time --- README.md | 2 +- docs/ssr.md | 9 ++++++++- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 7cf800745..b5c803dc0 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/ssr.md b/docs/ssr.md index 35488a7e9..444abeb5f 100644 --- a/docs/ssr.md +++ b/docs/ssr.md @@ -1,10 +1,17 @@ # Server-Side Rendering +!> :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 +Sample repo at https://github.com/docsifyjs/docsify-ssr-demo ## Why SSR? + - Better SEO - Feeling cool