delete SSR #2105

trusktr · 2023-06-25T06:49:08Z

Part of

Simplify and modernize Docsify #2104

Summary

SSR was experimental and incomplete, namely not working with plugins, generally not an ideal way to manage code (duplication of Renderer), and none of us have shown any desire to continue implementing that path.

I have better ideas (discord discussion) on the how to leverage tools like Solid Start, Astro, or Qwik.js for SSR and SSG in ways that will be way better than what we had going on.

Note: if we use Astro or Qwik, for example, this opens up the door to allowing people to write not just Vue inside Docsify, but also Solid, React, Svelte, Custom Elements, and more.

So this removes SSR, which we believe is not the ideal way to proceed.

Later, when someone desires and has the time, they can propose a new and complete SSR/SSG implementation that is on a good path, not duplicating a bunch of logic, ideally aligned with modern tech.

Thought leaders from Next.js, Nuxt.js, Solid Start, SvelteKit, and more recently the generic solutions Astro and Qwik, have been ironing out the details of SSR, SSG, CSG for a looooong time; they are masters at it. We should pursue a robust modern solution based on those when we sit down to finally do this.

What kind of change does this PR introduce?

Feature removal: delete SSR.

For any code change,

Related documentation has been updated if needed
Related tests have been updated or tests have been added

Does this PR introduce a breaking change? (check one)

Yes
No

Breaking change because someone might be using it. This requires a major version bump.

Related issue, if any:

I am planning to finish a few more things in a row here:

#2104.

We can wait for all of those (except perhaps TypeScript) before releasing a major version bump so that we don't release several major version bumps back to back.

Tested in the following browsers:

vercel · 2023-06-25T06:49:12Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
docsify-preview	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jun 30, 2023 2:55am

codesandbox-ci · 2023-06-25T06:50:19Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

Latest deployment of this branch, based on commit 8d5d204:

Sandbox	Source
docsify-template	Configuration

trusktr · 2023-06-25T07:32:22Z

test/integration/__snapshots__/docs.test.js.snap

@@ -9,4 +9,4 @@ exports[`Docs Site coverpage renders and is unchanged 1`] = `

 exports[`Docs Site navbar renders and is unchanged 1`] = `"<nav class=\\"app-nav no-badge\\"><ul><li>Translations<ul><li><a href=\\"#/\\" title=\\"undefined\\" class=\\"active\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ec-1f1e7.png?v8.png\\" alt=\\"uk\\" class=\\"emoji\\" loading=\\"lazy\\"> English</a></li><li><a href=\\"#/zh-cn/\\" title=\\"undefined\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e8-1f1f3.png?v8.png\\" alt=\\"cn\\" class=\\"emoji\\" loading=\\"lazy\\"> 简体中文</a></li><li><a href=\\"#/de-de/\\" title=\\"undefined\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f1e9-1f1ea.png?v8.png\\" alt=\\"de\\" class=\\"emoji\\" loading=\\"lazy\\"> Deutsch</a></li><li><a href=\\"#/es/\\" title=\\"undefined\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f1ea-1f1f8.png?v8.png\\" alt=\\"es\\" class=\\"emoji\\" loading=\\"lazy\\"> Español</a></li><li><a href=\\"#/ru-ru/\\" title=\\"undefined\\"><img src=\\"https://github.githubassets.com/images/icons/emoji/unicode/1f1f7-1f1fa.png?v8.png\\" alt=\\"ru\\" class=\\"emoji\\" loading=\\"lazy\\"> Русский</a></li></ul></li></ul></nav>"`;

-exports[`Docs Site sidebar renders and is unchanged 1`] = `"<aside class=\\"sidebar\\"><div class=\\"sidebar-nav\\"><ul><li><p>Getting started</p><ul><li><a href=\\"#/quickstart\\" title=\\"undefined\\">Quick start</a></li><li><a href=\\"#/more-pages\\" title=\\"undefined\\">Writing more pages</a></li><li><a href=\\"#/custom-navbar\\" title=\\"undefined\\">Custom navbar</a></li><li><a href=\\"#/cover\\" title=\\"undefined\\">Cover page</a></li></ul></li><li><p>Customization</p><ul><li><a href=\\"#/configuration\\" title=\\"undefined\\">Configuration</a></li><li><a href=\\"#/themes\\" title=\\"undefined\\">Themes</a></li><li><a href=\\"#/plugins\\" title=\\"undefined\\">List of Plugins</a></li><li><a href=\\"#/write-a-plugin\\" title=\\"undefined\\">Write a Plugin</a></li><li><a href=\\"#/markdown\\" title=\\"undefined\\">Markdown configuration</a></li><li><a href=\\"#/language-highlight\\" title=\\"undefined\\">Language highlighting</a></li><li><a href=\\"#/emoji\\" title=\\"undefined\\">Emoji</a></li></ul></li><li><p>Guide</p><ul><li><a href=\\"#/deploy\\" title=\\"undefined\\">Deploy</a></li><li><a href=\\"#/helpers\\" title=\\"undefined\\">Helpers</a></li><li><a href=\\"#/vue\\" title=\\"undefined\\">Vue compatibility</a></li><li><a href=\\"#/cdn\\" title=\\"undefined\\">CDN</a></li><li><a href=\\"#/pwa\\" title=\\"undefined\\">Offline Mode (PWA)</a></li><li><a href=\\"#/ssr\\" title=\\"undefined\\">Server-Side Rendering (SSR)</a></li><li><a href=\\"#/embed-files\\" title=\\"undefined\\">Embed Files</a></li></ul></li><li><p><a href=\\"#/awesome\\" title=\\"undefined\\">Awesome docsify</a></p></li><li><p><a href=\\"#/changelog\\" title=\\"undefined\\">Changelog</a></p></li></ul></div></aside>"`;
+exports[`Docs Site sidebar renders and is unchanged 1`] = `"<aside class=\\"sidebar\\"><div class=\\"sidebar-nav\\"><ul><li><p>Getting started</p><ul><li><a href=\\"#/quickstart\\" title=\\"undefined\\">Quick start</a></li><li><a href=\\"#/more-pages\\" title=\\"undefined\\">Writing more pages</a></li><li><a href=\\"#/custom-navbar\\" title=\\"undefined\\">Custom navbar</a></li><li><a href=\\"#/cover\\" title=\\"undefined\\">Cover page</a></li></ul></li><li><p>Customization</p><ul><li><a href=\\"#/configuration\\" title=\\"undefined\\">Configuration</a></li><li><a href=\\"#/themes\\" title=\\"undefined\\">Themes</a></li><li><a href=\\"#/plugins\\" title=\\"undefined\\">List of Plugins</a></li><li><a href=\\"#/write-a-plugin\\" title=\\"undefined\\">Write a Plugin</a></li><li><a href=\\"#/markdown\\" title=\\"undefined\\">Markdown configuration</a></li><li><a href=\\"#/language-highlight\\" title=\\"undefined\\">Language highlighting</a></li><li><a href=\\"#/emoji\\" title=\\"undefined\\">Emoji</a></li></ul></li><li><p>Guide</p><ul><li><a href=\\"#/deploy\\" title=\\"undefined\\">Deploy</a></li><li><a href=\\"#/helpers\\" title=\\"undefined\\">Helpers</a></li><li><a href=\\"#/vue\\" title=\\"undefined\\">Vue compatibility</a></li><li><a href=\\"#/cdn\\" title=\\"undefined\\">CDN</a></li><li><a href=\\"#/pwa\\" title=\\"undefined\\">Offline Mode (PWA)</a></li><li><a href=\\"#/embed-files\\" title=\\"undefined\\">Embed Files</a></li></ul></li><li><p><a href=\\"#/awesome\\" title=\\"undefined\\">Awesome docsify</a></p></li><li><p><a href=\\"#/changelog\\" title=\\"undefined\\">Changelog</a></p></li></ul></div></aside>"`;


It is very difficult to review these sorts of text-based snapshots. The only thing that changed here is that the server-side rendering sidebar menu item has been removed.

sy-records · 2023-06-25T07:48:53Z

Use Angular commit message to generate change logs

package.json

BREAKING: SSR removed Anyone depending on SSR will need to stay on an old Docsify version for now, move forward without SSR, or maintain SSR against a fork of updated Docsify. We have ideas on a better way to implement SSR, but these ideas have not been implemented yet.

trusktr · 2023-06-25T19:12:21Z

Use Angular commit message to generate change logs

Updated

trusktr · 2023-06-30T02:18:28Z

Looks like the codesandbox build sometimes fails when its system limits the number of process (EAGAIN error).

Is there a way to make it retry?

sy-records · 2023-06-30T02:22:01Z

I tried to access the admin codesandbox before, but I don't have access.
Previously added by @anikethsaha , Can you help to see it?

* develop: feat: add google analytics gtag.js plugin (#1702) chore: bump conventional-changelog-cli from 2.2.2 to 3.0.0 (#2085)

trusktr · 2023-07-02T07:09:55Z

No reply from @anikethsaha yet.

@sy-records @Koooooo-7 codesandbox build is not required, so we can continue anyway.

trusktr · 2023-07-02T18:25:36Z

@Koooooo-7 Because you already approved, and I merged develop and tests passed but it undid your approval, and then @sy-records approved, I'll go ahead and merge.

trusktr requested a review from a team June 25, 2023 06:49

trusktr force-pushed the delete-ssr branch from cb2f37c to 8d0b15a Compare June 25, 2023 06:55

vercel bot deployed to Preview June 25, 2023 06:56 View deployment

This was referenced Jun 25, 2023

Simplify and modernize Docsify #2104

Closed

conversion to ESM, and deletion of CommonJS #2106

Merged

sy-records changed the title ~~delete SSR~~ feat: delete SSR Jun 25, 2023

trusktr commented Jun 25, 2023

View reviewed changes

trusktr changed the title ~~feat: delete SSR~~ delete SSR Jun 25, 2023

sy-records reviewed Jun 25, 2023

View reviewed changes

package.json Show resolved Hide resolved

trusktr force-pushed the delete-ssr branch from 8d0b15a to 8d5d204 Compare June 25, 2023 19:09

vercel bot deployed to Preview June 25, 2023 19:09 View deployment

Koooooo-7 previously approved these changes Jun 26, 2023

View reviewed changes

sy-records mentioned this pull request Jun 29, 2023

chore: bump lerna from 7.0.2 to 7.1.0 #2108

Closed

trusktr dismissed Koooooo-7’s stale review via c2ff6de June 30, 2023 01:55

vercel bot deployed to Preview June 30, 2023 01:56 View deployment

trusktr requested review from Koooooo-7 and sy-records June 30, 2023 02:18

Merge branch 'develop' into delete-ssr

103dde8

* develop: feat: add google analytics gtag.js plugin (#1702) chore: bump conventional-changelog-cli from 2.2.2 to 3.0.0 (#2085)

trusktr force-pushed the delete-ssr branch from c2ff6de to 103dde8 Compare June 30, 2023 02:55

vercel bot deployed to Preview June 30, 2023 02:55 View deployment

sy-records approved these changes Jul 2, 2023

View reviewed changes

trusktr merged commit 85c3c2e into develop Jul 2, 2023

trusktr deleted the delete-ssr branch July 2, 2023 18:34

trusktr mentioned this pull request Jul 6, 2023

Update marked version to 4 to avoid vulnerability #1852

Closed

jhildenbiddle mentioned this pull request Oct 24, 2023

Bring docsify-cli into this repo for easier development. #2277

Open

This was referenced Nov 18, 2023

fix: ssr TypeError: Cannot read property 'indexOf' of undefined #1627

Closed

还没完美支持ssr，修改对应的中文文档 docsifyjs/docs-zh#51

Closed

sy-records mentioned this pull request Mar 6, 2024

The SSR example failed #1413

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

delete SSR #2105

delete SSR #2105

trusktr commented Jun 25, 2023 •

edited

Loading

vercel bot commented Jun 25, 2023 •

edited

Loading

codesandbox-ci bot commented Jun 25, 2023 •

edited

Loading

trusktr Jun 25, 2023

sy-records commented Jun 25, 2023

trusktr commented Jun 25, 2023

trusktr commented Jun 30, 2023

sy-records commented Jun 30, 2023

trusktr commented Jul 2, 2023

trusktr commented Jul 2, 2023

delete SSR #2105

delete SSR #2105

Conversation

trusktr commented Jun 25, 2023 • edited Loading

Summary

What kind of change does this PR introduce?

For any code change,

Does this PR introduce a breaking change? (check one)

Related issue, if any:

Tested in the following browsers:

vercel bot commented Jun 25, 2023 • edited Loading

codesandbox-ci bot commented Jun 25, 2023 • edited Loading

trusktr Jun 25, 2023

Choose a reason for hiding this comment

sy-records commented Jun 25, 2023

trusktr commented Jun 25, 2023

trusktr commented Jun 30, 2023

sy-records commented Jun 30, 2023

trusktr commented Jul 2, 2023

trusktr commented Jul 2, 2023

trusktr commented Jun 25, 2023 •

edited

Loading

vercel bot commented Jun 25, 2023 •

edited

Loading

codesandbox-ci bot commented Jun 25, 2023 •

edited

Loading