Skip to content

mention that SSR support is experimental and incomplete #47

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ docsify 可以快速帮你生成文档网站。不同于 GitBook、Hexo 的地
- 丰富的 API
- 支持 Emoji
- 兼容 IE11
- 支持服务端渲染 SSR ([示例](https://github.com/docsifyjs/docsify-ssr-demo))
- 实验性服务端渲染(SSR)支持 ([示例](https://github.com/docsifyjs/docsify-ssr-demo))

## 示例

Expand Down
14 changes: 8 additions & 6 deletions ssr.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@
# 服务端渲染(SSR)

先看例子 https://docsify.now.sh
!> :construction: SSR 支持是实验性的并且尚未完成。我们仍在继续开发。插件和部分 docsify 的特性在 SSR 模式中无法使用。 :construction:

项目地址在 https://github.com/docsifyjs/docsify-ssr-demo
<!--
这个地方本来有一个示例链接但是挂了
https://docsify.now.sh
-->

![](https://dn-mhke0kuv.qbox.me/2bfef08c592706108055.png)
示例项目地址 https://github.com/docsifyjs/docsify-ssr-demo

文档依旧是部署在 GitHub Pages 上,Node 服务部署在 now.sh 里,渲染的内容是从 GitHub Pages 上同步过来的。所以静态部署文档的服务器和服务端渲染的 Node 服务器是分开的,也就是说你还是可以用之前的方式更新文档,并不需要每次都部署。

## 什么是 SSR?
## 为什么选择 SSR?

- 更好的 SEO
- 更酷的感觉

Expand Down Expand Up @@ -111,8 +115,6 @@ module.exports = {
```




## 更多玩法

你可以直接在你的 Node 服务器上执行 `docsify start` 。
Expand Down